Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RTCGuest

视频访客模块

Hierarchy

  • EventTarget
    • RTCGuest

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

participantMap

  • get participantMap(): {}

  • 会议成员对象的集合 集合的key为成员的uri, key为 self 表示自己(即: participantMap['self'] === selfParticipant)

    Returns {}

selfParticipant

state

videoLayout

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)

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

call

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

destroy

  • destroy(): Promise<any>

disableAudioOutput

  • disableAudioOutput(): Promise<any>

disableUploadAudioStream

  • disableUploadAudioStream(): Promise<any>

disableUploadVideoStream

  • disableUploadVideoStream(): Promise<any>

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

enableAudioOutput

  • enableAudioOutput(): Promise<any>

enableUploadAudioStream

  • enableUploadAudioStream(): Promise<any>

enableUploadVideoStream

  • enableUploadVideoStream(): Promise<any>

hasListener

  • hasListener(type: EventTargetType): boolean

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

    Parameters

    • type: EventTargetType

    Returns boolean

listAllGroups

login

logout

  • logout(): Promise<any>

oneToOneCall

  • oneToOneCall(userId: string, callParam?: GuestCallParam): Promise<any>

  • 一对一呼叫

    Parameters

    • userId: string

      被呼叫方id

    • Default value callParam: GuestCallParam = {}

      呼叫参数

    Returns Promise<any>

removeEventListener

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

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

    Parameters

    • type: EventTargetType

      要移除的事件监听器类型

    • func: EventListenerType

      要移除的事件监听器

    Returns boolean

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

requestUrgent

  • requestUrgent(): Promise<any>

requestVideo

  • requestVideo(participant: string, pictureSize: GuestPictureSize): Promise<any>

sendMessage

  • sendMessage(type: string, content: string | Object, toUserId?: string | ConferenceParticipant): Promise<any>

sendSignalling

  • sendSignalling(signal: string | Object, options?: { destination?: string; isNewFormat?: boolean; isPlainText?: boolean; needAck?: boolean; type?: "msg" | "ice" | "sdp" | "cmd" }): Promise<any>

  • 发送信令消息, 可指定发送的目的地

    Parameters

    • signal: string | Object

      信令消息

    • Default value options: { destination?: string; isNewFormat?: boolean; isPlainText?: boolean; needAck?: boolean; type?: "msg" | "ice" | "sdp" | "cmd" } = {}

      可选项

      • Optional destination?: string
      • Optional isNewFormat?: boolean
      • Optional isPlainText?: boolean
      • Optional needAck?: boolean
      • Optional type?: "msg" | "ice" | "sdp" | "cmd"

    Returns Promise<any>

setAudioRoute

setRatio

  • setRatio(ratio: number): Promise<any>

setRequestVideo

startCameraVideo

startVideo

switchCamera

switchStream

  • 切换通过WebRTC传输的本地媒体流, 可用于发送从 <canvas> <video> 中获取到的 MediaStream

    Parameters

    Returns Promise<RTCStream>

term

  • term(): Promise<any>

Generated using TypeDoc