Class InnerWeChatLocalStream

Hierarchy

Reportable
- InnerWeChatLocalStream

Implements

IRTCStream

Constructors

constructor

new InnerWeChatLocalStream(options: Partial<WeChatLocalStreamOptions>): InnerWeChatLocalStream

Overrides Reportable.constructor
Parameters
- options: Partial<WeChatLocalStreamOptions>
Returns InnerWeChatLocalStream

Properties

Readonly __constructorName

__constructorName: string

id

id: string

listenerMap

listenerMap: Record<EventTargetType, IEventListenerObject[]>

Readonly reporter

reporter: Reporter

statsReport

statsReport: IWeChatMiniprogramPusherStatsReport

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: EventListenerOptions

Static DEFAULT_STREAM_OPTIONS

DEFAULT_STREAM_OPTIONS: WeChatLocalStreamOptions

Static IGNORE_FUNCTION_MEMBER

IGNORE_FUNCTION_MEMBER: PropertyKey[]

Static reporterManager

reporterManager: ReporterManager

Accessors

audioLevel

get audioLevel(): number

Returns number

audioState

get audioState(): boolean

Implementation of IRTCStream.audioState
Returns boolean

options

get options(): WeChatLocalStreamOptions

Returns WeChatLocalStreamOptions

state

get state(): IRTCStreamState
set state(state: IRTCStreamState): void

Implementation of IRTCStream.state
Returns IRTCStreamState
Implementation of IRTCStream.state
Parameters
- state: IRTCStreamState
Returns void

videoState

get videoState(): boolean

Implementation of IRTCStream.videoState
Returns boolean

Methods

addEventListener

addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from Reportable.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 添加事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

addEventListeners

addEventListeners(types: EventTargetType[], func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from Reportable.addEventListeners

对多个事件添加同一个事件监听器

Parameters
- types: EventTargetType[]
  要监听的事件类型
- func: EventListenerType
  事件监听回调
- Optional options: EventListenerOptions
  设置监听器参数
Returns () => void
若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - 对多个事件添加同一个事件监听器
    
    Returns void
    若添加成功则返回一个函数, 用于移除事件监听

clearListener

clearListener(): void

Inherited from Reportable.clearListener

清空所有绑定的事件

Returns void

disableAudio

disableAudio(): Promise<void>

Implementation of IRTCStream.disableAudio
Returns Promise<void>

disableVideo

disableVideo(): Promise<void>

Implementation of IRTCStream.disableVideo
Returns Promise<void>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from Reportable.dispatchEvent

分发事件

Parameters
- event: Event
  分发的事件对象
Returns boolean
事件是否发送成功

dispatchEventLite

dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): boolean

Inherited from Reportable.dispatchEventLite

简化的dispatchEvent接口

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
  具体错误类型, 此时 dispatchEventLite的 type 应是一个 xxxEventType.Error 类型
Returns boolean

enableAudio

enableAudio(): Promise<void>

Implementation of IRTCStream.enableAudio
Returns Promise<void>

enableVideo

enableVideo(): Promise<void>

Implementation of IRTCStream.enableVideo
Returns Promise<void>

getAudioLevel

getAudioLevel(): number

Implementation of IRTCStream.getAudioLevel
Returns number

hasListener

hasListener(type: EventTargetType): boolean

Inherited from Reportable.hasListener

指定类型的事件是否被监听

Parameters
- type: EventTargetType
Returns boolean

pause

pause(): Promise<void>

Returns Promise<void>

removeEventListener

removeEventListener(type: EventTargetType, func: EventListenerType): boolean

Inherited from Reportable.removeEventListener

移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

Parameters
- type: EventTargetType
  要移除的事件监听器类型
- func: EventListenerType
  要移除的事件监听器
Returns boolean
返回 true 表示移除成功

reset

reset(options?: Partial<WeChatLocalStreamOptions>): Promise<void>

Implementation of IRTCStream.reset
Parameters
- Optional options: Partial<WeChatLocalStreamOptions>
Returns Promise<void>

resume

resume(): Promise<void>

Implementation of IRTCStream.resume
Returns Promise<void>

rotate

rotate(angle: IRTCStreamRotate): boolean

Implementation of IRTCStream.rotate
Parameters
- angle: IRTCStreamRotate
Returns boolean

setAudioOutput

setAudioOutput(): Promise<void>

Implementation of IRTCStream.setAudioOutput
Returns Promise<void>

snapshot

snapshot(): Promise<unknown>

Implementation of IRTCStream.snapshot
Returns Promise<unknown>

start

start(id: string, page?: TrivialInstance): Promise<void>

Implementation of IRTCStream.start
Parameters
- id: string
- Optional page: TrivialInstance
Returns Promise<void>

startPreview

startPreview(id: string, page?: TrivialInstance): Promise<void>

Parameters
- id: string
- Optional page: TrivialInstance
Returns Promise<void>

stop

stop(): Promise<void>

Implementation of IRTCStream.stop
Returns Promise<void>

stopPreview

stopPreview(): Promise<void>

Returns Promise<void>

switchCamera

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

Implementation of IRTCStream.switchCamera

切换摄像头

Parameters
- camera: "front" | "back"
  front: 前置摄像头, back: 后置摄像头
Returns Promise<void>

toJSON

toJSON(): Record<string, unknown>

Returns Record<string, unknown>

toString

toString(): string

Inherited from Reportable.toString
Returns string

Generated using TypeDoc