Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RTCStream

Hierarchy

  • EventTarget
    • RTCStream

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

audioSource

  • get audioSource(): MediaStreamTrack

  • 获取音频轨道对象

    Returns MediaStreamTrack

domUniqueId

  • get domUniqueId(): string

  • Returns string

state

videoSource

  • get videoSource(): MediaStreamTrack

  • 获取视频轨道对象

    Returns MediaStreamTrack

wrapperDOMId

  • get wrapperDOMId(): string

  • Returns string

Methods

addEventListener

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

  • 添加事件监听器

    Parameters

    • type: EventTargetType

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

    Returns () => void

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

      • (): void

      • Returns void

addEventListeners

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

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

    Parameters

    • types: EventTargetType[]

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

      设置监听器参数

    Returns false | (() => void)

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

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

disableAudio

  • disableAudio(): Promise<any>

disableVideo

  • disableVideo(): Promise<any>

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • 分发事件

    Parameters

    • event: Event

      分发的事件对象

    Returns boolean

    事件是否发送成功

dispatchEventLite

  • dispatchEventLite(type: EventTargetType, message?: any, error?: EventTargetType): void

  • 简化分发事件接口, 如需要分发的是错误事件, error参数传入具体错误类型

    Parameters

    • type: EventTargetType

      事件类型

    • Optional message: any

      消息

    • Optional error: EventTargetType

      错误类型

    Returns void

enableAudio

  • enableAudio(): Promise<any>

enableVideo

  • enableVideo(): Promise<any>

hasListener

  • hasListener(type: EventTargetType): boolean

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

    Parameters

    • type: EventTargetType

    Returns boolean

removeEventListener

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

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

    Parameters

    • type: EventTargetType

      要移除的事件监听器类型

    • func: EventListenerType

      要移除的事件监听器

    Returns boolean

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

setAudioOutput

  • setAudioOutput(deviceId: string): Promise<any>

  • 见 Stream.setAudioOutput

    Parameters

    • deviceId: string

      传入对应的音频输出设备deviceId

    Returns Promise<any>

snapshot

  • snapshot(): Promise<any>

start

  • start(id?: string, options?: { includeVideoDOM: boolean }): Promise<any>

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

    Parameters

    • id: string = ...

      在id对应的DOM元素中渲染画面

    • options: { includeVideoDOM: boolean } = ...

      额外选项

      • includeVideoDOM: boolean

        在then的返回值中是否包含video的dom元素, 默认只会返回audio的dom元素

    Returns Promise<any>

stop

  • stop(): Promise<any>

updateOptions

Generated using TypeDoc