Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WeChatLocalStream

该类表示微信小程序中的本地媒体流

由于微信小程序的特殊性, 无法通过DOM操作设置<live-pusher>的属性, 因此需要使用<local-stream>组件来代替<live-pusher>, 同理, 使用<remote-stream>代替<live-player>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

_pageTarget

_pageTarget: any

component

component: WeChatLocalStreamContext

listenerMap

listenerMap: {}

Type declaration

options

options: WeChatLocalStreamOptions

userId

userId: string

Static reporter

reporter: Reporter = new Reporter('WeChatLocalStream')

Methods

addEventListener

addEventListeners

bindComponent

  • bindComponent(id: string, pageTarget?: any): Promise<any>

  • Parameters

    • id: string
    • Optional pageTarget: any

    Returns Promise<any>

clearListener

  • clearListener(): void

disableAudio

  • disableAudio(): Promise<any>

disablePreview

  • disablePreview(): Promise<any>

  • 关闭摄像头预览

    Returns Promise<any>

disableVideo

  • disableVideo(): Promise<any>

dispatchEvent

  • dispatchEvent(event: Event): boolean

dispatchEventLite

enableAudio

  • enableAudio(): Promise<any>

enablePreview

  • enablePreview(): Promise<any>

  • 开启摄像头预览

    Returns Promise<any>

enableVideo

  • enableVideo(): Promise<any>

hasListener

onbgmcomplete

  • onbgmcomplete(ev: any): void

  • Parameters

    • ev: any

    Returns void

onbgmprocess

  • onbgmprocess(ev: any): void

  • Parameters

    • ev: any

    Returns void

onbgmstart

  • onbgmstart(ev: any): void

  • Parameters

    • ev: any

    Returns void

onerror

  • onerror(ev: any): void

  • Parameters

    • ev: any

    Returns void

onnetstatechange

  • onnetstatechange(ev: any): void

  • Parameters

    • ev: any

    Returns void

onstatechange

  • onstatechange(ev: any): void

  • Parameters

    • ev: any

    Returns void

pause

  • pause(): Promise<any>

  • Returns Promise<any>

removeEventListener

reset

setAudioOutput

  • setAudioOutput(...args: any): Promise<any>

snapshot

  • snapshot(quality: "raw" | "compressed"): Promise<any>

  • Parameters

    • quality: "raw" | "compressed"

    Returns Promise<any>

start

  • start(id: string, pageTarget?: any): Promise<any>

  • Parameters

    • id: string
    • Optional pageTarget: any

    Returns Promise<any>

stop

  • stop(): Promise<any>

  • Returns Promise<any>

switchCamera

  • switchCamera(camera: "front" | "back"): Promise<any>

  • 切换摄像头

    Parameters

    • camera: "front" | "back"

    Returns Promise<any>

Object literals

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: object

once

once: false = false

Static DEFAULT_STREAM_OPTIONS

DEFAULT_STREAM_OPTIONS: object

aspect

aspect: "9:16" = "9:16"

audioQuality

audioQuality: "high" = "high"

audioReverbType

audioReverbType: number = 0

audioVolumeType

audioVolumeType: "voicecall" = "voicecall"

autoFocus

autoFocus: true = true

autopush

autopush: false = false

backgroundMute

backgroundMute: true = true

beauty

beauty: number = 0

debug

debug: false = false

devicePosition

devicePosition: "front" = "front"

enableAgc

enableAgc: false = false

enableAns

enableAns: false = false

enableCamera

enableCamera: true = true

enableMic

enableMic: true = true

hidden

hidden: false = false

localMirror

localMirror: "auto" = "auto"

maxBitrate

maxBitrate: number = 600

minBitrate

minBitrate: number = 450

mode

mode: "RTC" = "RTC"

orientation

orientation: "vertical" = "vertical"

pushUrl

pushUrl: null = null

remoteMirror

remoteMirror: false = false

videoHeight

videoHeight: number = 640

videoWidth

videoWidth: number = 360

waitingImage

waitingImage: string = ""

waitingImageHash

waitingImageHash: string = ""

whiteness

whiteness: number = 0

zoom

zoom: false = false

Generated using TypeDoc