Class InnerWebRTCStream

Hierarchy

Reportable
- InnerWebRTCStream

Implements

IRTCStream

Constructors

constructor

new InnerWebRTCStream(options: Partial<IRTCStreamOptions>): InnerWebRTCStream

Overrides Reportable.constructor
Parameters
- options: Partial<IRTCStreamOptions>
Returns InnerWebRTCStream

Properties

Readonly __constructorName

__constructorName: string

listenerMap

listenerMap: Record<EventTargetType, IEventListenerObject[]>

Readonly reporter

reporter: Reporter

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: EventListenerOptions

Static IGNORE_FUNCTION_MEMBER

IGNORE_FUNCTION_MEMBER: PropertyKey[]

Static reporterManager

reporterManager: ReporterManager

Accessors

audioDOM

get audioDOM(): HTMLAudioElement

Returns HTMLAudioElement

audioLevel

set audioLevel(audioLevel: number): void

Parameters
- audioLevel: number
Returns void

audioSource

get audioSource(): MediaStreamTrack

Returns MediaStreamTrack

audioState

get audioState(): boolean

Implementation of IRTCStream.audioState
Returns boolean

audioStream

get audioStream(): MediaStream

Returns MediaStream

canvasDOM

get canvasDOM(): HTMLCanvasElement

Returns HTMLCanvasElement

state

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

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

videoDOM

get videoDOM(): HTMLVideoElement

Returns HTMLVideoElement

videoSource

get videoSource(): MediaStreamTrack

Returns MediaStreamTrack

videoState

get videoState(): boolean

Implementation of IRTCStream.videoState
Returns boolean

videoStream

get videoStream(): MediaStream

Returns MediaStream

wrapperDOMId

get wrapperDOMId(): string

Returns string

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

close

close(): Promise<void>

关闭本地音视频轨道, 并释放媒体设备

Returns Promise<void>

disableAudio

disableAudio(options?: Partial<IRTCStreamMediaOperateOptions>): Promise<void>

Implementation of IRTCStream.disableAudio
Parameters
- Optional options: Partial<IRTCStreamMediaOperateOptions>
Returns Promise<void>

disableVideo

disableVideo(options?: Partial<IRTCStreamMediaOperateOptions>): Promise<void>

Implementation of IRTCStream.disableVideo
Parameters
- Optional options: Partial<IRTCStreamMediaOperateOptions>
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(options?: Partial<IRTCStreamMediaOperateOptions>): Promise<void>

Implementation of IRTCStream.enableAudio
Parameters
- Optional options: Partial<IRTCStreamMediaOperateOptions>
Returns Promise<void>

enableVideo

enableVideo(options?: Partial<IRTCStreamMediaOperateOptions>): Promise<void>

Implementation of IRTCStream.enableVideo
Parameters
- Optional options: Partial<IRTCStreamMediaOperateOptions>
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

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<IRTCStreamOptions>): void

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

resetRenderStyle

resetRenderStyle(): void

Returns 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(modeOrDeviceId: string): Promise<void>

Implementation of IRTCStream.setAudioOutput
Parameters
- modeOrDeviceId: string
Returns Promise<void>

snapshot

snapshot(): Promise<Blob>

Implementation of IRTCStream.snapshot
Returns Promise<Blob>

start

start(id?: string, page?: Document | DocumentFragment, options?: { includeVideoDOM: boolean }): Promise<void>

Implementation of IRTCStream.start
Parameters
- Optional id: string
- Optional page: Document | DocumentFragment
- Optional options: { includeVideoDOM: boolean }
  - includeVideoDOM: boolean
Returns Promise<void>

stop

stop(): Promise<void>

Implementation of IRTCStream.stop
Returns Promise<void>

switchCamera

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

Implementation of IRTCStream.switchCamera
Parameters
- camera: "front" | "back"
Returns Promise<void>

toString

toString(): string

Inherited from Reportable.toString
Returns string

Generated using TypeDoc