Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implemented by

Index

Properties

conferenceDeliveryInfo

conferenceDeliveryInfo: ConferenceDeliveryInfo

conferenceDeliveryOptions

conferenceDeliveryOptions: ConferenceDeliveryOptions

participantMap

participantMap: Record<string, Participant>

self

Methods

destroy

  • destroy(): void

disableAudioOutput

  • disableAudioOutput(): Promise<void>
  • 取消订阅会议音频流

    Returns Promise<void>

disableUploadAudioStream

disableUploadVideoStream

enableAudioOutput

  • enableAudioOutput(): Promise<void>
  • 订阅会议音频流,关闭订阅将无法听到会议中其他成员的声音

    Returns Promise<void>

enableUploadAudioStream

enableUploadVideoStream

inviteSipUser

join

  • 加入一个会议,结果回调由ConferenceEventType.CONFERENCE_JOIN上报

    Parameters

    • confNumber: string

      传 "0" 由服务器生成10位的会议号,可传字母或数字作为自定义会议号

    • joinParam: Partial<ConferenceJoinParam>

      加入会议额外参数

    Returns Promise<void>

leave

  • leave(): Promise<void>

login

logout

  • logout(): Promise<void>
  • 登出

    Returns Promise<void>

query

  • 根据 channelId(房间号) 查询会议是否存在

    Parameters

    • channelId: string

    Returns Promise<QueryChannelInfo>

requestVideo

  • 请求用户的视频流 当 pictureSize 为 PictureSizeNone 标识关闭请求

    see

    ConferencePictureSize

    Parameters

    Returns Promise<void>

sendMessage

  • sendMessage(type: string, content: string | Record<string, unknown>, toUserId?: string): Promise<void>
  • 频道中发送消息,当 toUserId 不为 null 时,content 不能大于 4k 此接口调用成功后,消息接收方会收到 ConferenceEventType.MESSAGE_RECEIVE 事件,通过此事件可以获取消息的文本类型和文本内容

    Parameters

    • type: string

      消息类型

    • content: string | Record<string, unknown>

      消息内容

    • Optional toUserId: string

      接收方成员的userid,值为null发送给所有人

    Returns Promise<void>

sendOnlineMessage

  • sendOnlineMessage(toUserId: string, content: string | Record<string, unknown>): Promise<void>
  • 发送在线消息

    Parameters

    • toUserId: string

      接收者的uri

    • content: string | Record<string, unknown>

      消息内容, 如传入json对象会通过{@link JSON}字符串化

    Returns Promise<void>

sendTextMessage

  • sendTextMessage(content: string, toUserId?: string): Promise<void>

setAudioRoute

  • setAudioRoute(route: "speaker" | "ear"): Promise<void>
  • 设置音频路由, 听筒或扬声器等

    Parameters

    • route: "speaker" | "ear"

    Returns Promise<void>

setLayout

setRatio

  • setRatio(ratio: number): Promise<void>
  • 设置对端接收到的访客画面的宽高比

    Parameters

    • ratio: number

      宽高比

    Returns Promise<void>

start

  • deprecated

    创建并加入一个会议,结果回调由ConferenceEventType.CONFERENCE_JOIN上报

    Parameters

    • confNumber: string

      传 "0" 由服务器生成10位的会议号,可传字母或数字作为自定义会议号

    • joinParam: Partial<ConferenceJoinParam>

      加入会议的额外参数

    Returns Promise<void>

startCameraVideo

  • 获得视频预览对象,通过此对象能获得本地摄像头画面用于UI显示, 获取媒体设备失败的错误见{@link RTCStreamErrorType}

    see

    IRTCStreamRenderType

    Parameters

    Returns Promise<IRTCStream>

startVideo

  • 获得视频对象,通过此对象能获得远端画面用于UI显示

    see

    IRTCStreamRenderType

    Parameters

    Returns Promise<IRTCStream>

stop

  • stop(): Promise<void>
  • 结束会议,由返回的Promise或ConferenceEventType.CONFERENCE_LEAVE事件表示结果.

    client.stop()
    .then(() => {
    // todo
    })
    .catch((reason) => {
    // todo
    })

    // or

    client.stop();

    client.addEventListener(ConferenceEventType.CONFERENCE_LEAVE, (ev) => {
    const result = ev.message.result;

    // todo
    });

    Returns Promise<void>

switchCamera

Generated using TypeDoc