Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Guest

Guest类定义了继承该类的子类需要实现的接口

Hierarchy

  • Guest

Implemented by

Index

Methods

Methods

call

  • 发起呼叫

    Parameters

    • number: string

      业务号

    • Optional callParam: GuestCallParam

      呼叫参数

    Returns Promise<any>

destroy

  • destroy(): Promise<any>

  • 销毁client, 调用term或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>

listAllGroups

  • listAllGroups(): Promise<any>

  • 获取业务列表

    Returns Promise<any>

login

  • 登录

    Parameters

    Returns Promise<any>

logout

  • logout(): Promise<any>

  • 登出

    Returns Promise<any>

requestUrgent

  • requestUrgent(): Promise<any>

  • 排队加急

    Returns Promise<any>

requestVideo

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

  • 请求用户的视频流

    Parameters

    • participant: string

      用户对象

    • pictureSize: GuestPictureSize

      视频请求尺寸类型

    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>

setRatio

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

  • 设置对端接收到的访客画面的宽高比

    Parameters

    • ratio: number

      宽高比

    Returns Promise<any>

setRequestVideo

  • 设置远端视频流的分辨率

    Parameters

    Returns Promise<any>

startCameraVideo

  • startCameraVideo(renderType: any): Promise<Stream>

  • 获得视频预览对象，通过此对象能获得本地摄像头画面用于UI显示

    see

    RenderType

    Parameters

    • renderType: any

      渲染模式

    Returns Promise<Stream>

startVideo

  • startVideo(): Promise<Stream>

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

    Returns Promise<Stream>

switchCamera

term

  • term(): Promise<any>

Generated using TypeDoc