Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Conference

视频会议接口定义

Hierarchy

  • Conference

Implemented by

Index

Methods

Methods

destroy

  • destroy(): Promise<any>

  • 销毁client, 调用leave, stop或logout都会自动销毁

    Returns Promise<any>

disableAudioOutput

  • disableAudioOutput(): Promise<any>

  • 取消订阅会议音频流

    Returns Promise<any>

disableUploadAudioStream

  • disableUploadAudioStream(): Promise<any>

disableUploadVideoStream

  • disableUploadVideoStream(): Promise<any>

enableAudioOutput

  • enableAudioOutput(): Promise<any>

  • 订阅会议音频流，关闭订阅将无法听到会议中其他成员的声音

    Returns Promise<any>

enableUploadAudioStream

  • enableUploadAudioStream(): Promise<any>

enableUploadVideoStream

  • enableUploadVideoStream(): Promise<any>

join

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

    Parameters

    • confNumber: string

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

    • video: boolean

      传递 true 即可. 目前强制为视频会议, 语音会议暂不可用

    • joinParam: ConferenceJoinParam

      加入会议额外参数

    Returns Promise<any>

leave

  • leave(): Promise<any>

login

logout

  • logout(): Promise<any>

  • 登出

    Returns Promise<any>

query

  • query(channelId: string): Promise<any>

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

    Parameters

    • channelId: string

    Returns Promise<any>

requestVideo

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

    see

    ConferencePictureSize

    Parameters

    Returns Promise<any>

sendMessage

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

  • 发送消息，其他成员会收到ConferenceEventType.MESSAGE_RECEIVE回调, 如未指定toUserId, 则该消息将会广播给所有成员

    Parameters

    • type: string

      消息类型

    • content: string | Object

      消息内容. 当 toUserId 不为 null 时，content 不能大于 4k

    • toUserId: string

      接收者id，null则发给所有会议人员

    Returns Promise<any>

sendOnlineMessage

  • sendOnlineMessage(toUserId: string, content: string | Object): Promise<any>

  • 发送在线消息

    Parameters

    • toUserId: string

      接收者的uri

    • content: string | Object

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

    Returns Promise<any>

setAudioRoute

  • setAudioRoute(...args: any): Promise<any>

  • 设置音频路由, 听筒或扬声器等

    Parameters

    • Rest ...args: any

    Returns Promise<any>

start

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

    Parameters

    • confNumber: string

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

    • video: boolean

      true 视频会议，false 语音会议. 传递 true 即可. 目前强制为视频会议, 语音会议暂不可用

    • joinParam: ConferenceJoinParam

      加入会议的额外参数

    Returns Promise<any>

startCameraVideo

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

    see

    RenderType

    Parameters

    Returns Promise<Stream>

startVideo

  • startVideo(): Promise<Stream>

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

    Returns Promise<Stream>

stop

  • stop(): Promise<any>

switchCamera

Generated using TypeDoc