Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RTCCore

RTC核心

Hierarchy

  • EventTarget
    • RTCCore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RTCCore(iceServers: Array<RTCIceServer>, transportPolicy?: RTCIceTransportPolicy): RTCCore

  • 构造函数

    Parameters

    • iceServers: Array<RTCIceServer>

      服务器

    • Optional transportPolicy: RTCIceTransportPolicy

      转接协议

    Returns RTCCore

Properties

Static MAX_ICE_RESTART_COUNT

MAX_ICE_RESTART_COUNT: number = 3

ICE最大重连次数

Static reporter

reporter: Reporter = new Reporter('RTCCore')

Accessors

stats

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: Array<EventTargetType>, func: EventListenerType, options?: EventListenerOptions): false | (Anonymous function)

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

    Parameters

    • types: Array<EventTargetType>

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

      设置监听器参数

    Returns false | (Anonymous function)

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

addTrack

  • addTrack(track: MediaStreamTrack, streamId?: string): boolean

  • 添加音视频轨道

    Parameters

    • track: MediaStreamTrack
    • Default value streamId: string = this._localStream.id

    Returns boolean

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

destroy

  • destroy(): void

  • 销毁实例

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • 分发事件

    Parameters

    • event: Event

      分发的事件对象

    Returns boolean

    事件是否发送成功

dispatchEventLite

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

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

    Parameters

    • type: EventTargetType

      事件类型

    • Optional message: EventTargetData

      消息

    • Optional error: string | number

      错误类型

    Returns void

hasListener

  • hasListener(type: EventTargetType): boolean

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

    Parameters

    • type: EventTargetType

    Returns boolean

hasTrack

  • hasTrack(trackId: string): boolean

  • 是否有trackId对应的轨道

    Parameters

    • trackId: string

      轨道id

    Returns boolean

removeEventListener

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

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

    Parameters

    • type: EventTargetType

      要移除的事件监听器类型

    • func: EventListenerType

      要移除的事件监听器

    Returns boolean

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

removeTrack

  • removeTrack(track: MediaStreamTrack, streamId?: string): boolean

  • 移除音视频轨道

    Parameters

    • track: MediaStreamTrack
    • Default value streamId: string = this._localStream.id

    Returns boolean

replaceTrack

  • replaceTrack(track: MediaStreamTrack, streamId?: string): boolean

  • 替换轨道

    Parameters

    • track: MediaStreamTrack

      轨道

    • Default value streamId: string = this._localStream.id

      流id

    Returns boolean

resume

  • resume(): Promise<any>

  • 恢复连接

    Returns Promise<any>

setIceCandidate

  • setIceCandidate(iceInit: RTCIceCandidateInit): void

  • 设置候选者

    Parameters

    • iceInit: RTCIceCandidateInit

      候选者

    Returns void

setSDP

  • setSDP(sdp: RTCSessionDescriptionInit): void

  • 设置远端SDP

    Parameters

    • sdp: RTCSessionDescriptionInit

    Returns void

Generated using TypeDoc