RTCStream | wechat-conference-sdk

Hierarchy

EventTarget
- RTCStream

Implements

Stream

Index

Constructors

constructor

Properties

Accessors

Object literals

Constructors

constructor

new RTCStream(options: StreamOptions): RTCStream

Overrides EventTarget.constructor

Parameters
- options: StreamOptions
Returns RTCStream

Properties

_audioSource

_audioSource: MediaStreamTrack

_canvasDOM

_canvasDOM: HTMLCanvasElement

_ctx

_ctx: CanvasRenderingContext2D

_domUniqueId

_domUniqueId: string

创建的 video DOM元素的id

_options

_options: StreamOptions

_state

_state: StreamState

_stream

_stream: MediaStream

_videoDOM

_videoDOM: HTMLVideoElement

_videoSource

_videoSource: MediaStreamTrack

_wrapperDOMId

_wrapperDOMId: string

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

Static SUPPORTED_CONSTRAINTS

SUPPORTED_CONSTRAINTS: MediaTrackSupportedConstraints = isBrowser ? navigator.mediaDevices.getSupportedConstraints() : null

Static reporter

reporter: Reporter = new Reporter('RTCStream')

Accessors

audioSource

get audioSource(): MediaStreamTrack

Returns MediaStreamTrack

state

get state(): StreamState
set state(state: StreamState): void

Returns StreamState
Parameters
- state: StreamState
Returns void

videoSource

get videoSource(): MediaStreamTrack

Returns MediaStreamTrack

Methods

_canvasDOMInit

_canvasDOMInit(): HTMLCanvasElement

Returns HTMLCanvasElement

_optionsHandle

_optionsHandle(options?: StreamOptions): StreamOptions

Parameters
- Default value options: StreamOptions = {id: ''}
Returns StreamOptions

_streamInit

_streamInit(): Promise<void>

Returns Promise<void>

_videoDOMInit

_videoDOMInit(): HTMLVideoElement

Returns HTMLVideoElement

addEventListener

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

Inherited from EventTarget.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void

若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - Returns void

addEventListeners

addEventListeners(types: Array<EventTargetType>, func: EventListenerType, options?: EventListenerOptions): false | (Anonymous function)

Inherited from EventTarget.addEventListeners

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

Parameters
- types: Array<EventTargetType>
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
  
  设置监听器参数
Returns false | (Anonymous function)

若添加成功则返回一个函数, 用于移除事件监听

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

disableAudio

disableAudio(): Promise<any>

Implementation of Stream.disableAudio

Returns Promise<any>

disableVideo

disableVideo(): Promise<any>

Implementation of Stream.disableVideo

Returns Promise<any>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

分发事件

Parameters
- event: Event
  
  分发的事件对象
Returns boolean

事件是否发送成功

dispatchEventLite

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

Inherited from EventTarget.dispatchEventLite

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
Returns void

enableAudio

enableAudio(): Promise<any>

Implementation of Stream.enableAudio

Returns Promise<any>

enableVideo

enableVideo(): Promise<any>

Implementation of Stream.enableVideo

Returns Promise<any>

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

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

Parameters
- type: EventTargetType
Returns boolean

removeEventListener

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

Inherited from EventTarget.removeEventListener

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

Parameters
- type: EventTargetType
  
  要移除的事件监听器类型
- func: EventListenerType
  
  要移除的事件监听器
Returns boolean

返回true表示有该fun监听器并且移除成功

setAudioOutput

setAudioOutput(deviceId: string): Promise<any>

Parameters
- deviceId: string
Returns Promise<any>

snapshot

snapshot(): Promise<any>

Returns Promise<any>

start

start(id?: string): Promise<any>

由于浏览器的 autoplay policy 的限制, 非静音的音视频需要用户手动触发播放

Parameters
- Default value id: string = this._wrapperDOMId
Returns Promise<any>

stop

stop(): Promise<any>

Implementation of Stream.stop

Returns Promise<any>

updateOptions

updateOptions(options: StreamOptions): Promise<any>

Parameters
- options: StreamOptions
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

audio

audio: true = true

id

id: null = null

muted

muted: false = false

renderType

renderType: CONTAIN = RenderType.CONTAIN

video

video: true = true

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

options: StreamOptions

Returns RTCStream

Properties

_audioSource

_canvasDOM

_ctx

_domUniqueId

_options

_state

_stream

_videoDOM

_videoSource

_wrapperDOMId

listenerMap

Type declaration

[key: string]: Array<EventListenerType>

Static SUPPORTED_CONSTRAINTS

Static reporter

Accessors

audioSource

Returns MediaStreamTrack

state

Returns StreamState

Parameters

state: StreamState

Returns void

videoSource

Returns MediaStreamTrack

Methods

_canvasDOMInit

Returns HTMLCanvasElement

_optionsHandle

Parameters

Default value options: StreamOptions = {id: ''}

Returns StreamOptions

_streamInit

Returns Promise<void>

_videoDOMInit

Returns HTMLVideoElement

addEventListener

Parameters

type: EventTargetType

func: EventListenerType

Optional options: EventListenerOptions

Returns () => void

Returns void

addEventListeners

Parameters

types: Array<EventTargetType>

func: EventListenerType

Optional options: EventListenerOptions

Returns false | (Anonymous function)

clearListener

Returns void

disableAudio

Returns Promise<any>

disableVideo

Returns Promise<any>

dispatchEvent

Parameters

event: Event

Returns boolean

dispatchEventLite

Parameters

type: EventTargetType

Optional message: EventTargetData

Optional error: string | number

Returns void

enableAudio