Class JRTCGuest

访客管理

Hierarchy

Methods

create destroy requestVideo requestScreenVideo getCallState getCallType getHoldState isOnewayVideo isMainGuest getMainAgentParticipant getAgentParticipants getSelfParticipant getParticipants getSerialNumber getCallId getShareStreamId getShareUserId setMultiStream queryAllGroups call oneToOneCall answer term requestUrgent sendMessage sendNotifyMessage enableUploadAudioStream enableUploadVideoStream setRatio setRemoteMergeVideoProperty getRequestSize setRequestSize unRequestVideo unRequestScreenVideo enableRemoteRecord getRemoteRecordState responseSignResult statistics

Methods

Static create

  • create(client, mediaDevice, initParam, callback): undefined | JRTCGuest

  • 创建 JRTCGuest 对象，为单例，重复调用返回同一对象

    Parameters

    Returns undefined | JRTCGuest

    JRTCGuest 对象

    Note

    • 请确保在调用其他 API 前先调用该方法创建并初始化 JRTCClient 对象，JRTCMediaDevice 对象
    • 调用此方法前确保 JRTCClient 已完成初始化，即 getState 方法获取的状态值不等于 NOT_INIT
    • 调用此方法创建 JRTCGuest 对象后，期间没有调用过 destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JRTCGuest 对象

    Throws

    Error "初次创建时 JRTCClient、JRTCMediaDevice、JRTCGuestCallback 任意一个参数传空就会创建失败"

Static destroy

  • destroy(): void

  • 销毁 JRTCGuest 对象

    Returns void

    Note

    该方法为同步调用，需要等待 JRTCGuest 实例资源释放后才能执行其他操作，调用此方法后，你将无法再使用 JRTCGuest 的其它方法和回调。
    我们 不建议 在 JRTCSDK 的回调中调用此方法销毁 JRTCGuest 对象，否则可能出现崩溃现象。
    如需在销毁后再次创建 JRTCGuest 实例，需要等待 destroy 方法执行结束后再创建实例。

requestVideo

  • requestVideo(participant, videoSize): Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

  • 订阅通话中其他成员的视频流

    Parameters

    Returns Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

    包含视频流拉流地址(SRS地址)和媒体流对象

requestScreenVideo

  • requestScreenVideo(videoSize): Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

  • 订阅通话中屏幕共享的视频流

    Parameters

    Returns Promise<{
        streamUrl: string;
        mediaStream: MediaStream;
    }>

    包含视频流拉流地址(SRS地址)和媒体流对象

getCallState

  • getCallState(): CallState

  • 获取当前通话状态

    Returns CallState

    当前通话状态

getCallType

  • getCallType(): CallType

  • 获取当前通话类型

    Returns CallType

    当前通话类型

getHoldState

  • getHoldState(): boolean

  • 获取当前通话保持状态

    座席可修改当前通话的保持状态。

    Returns boolean

    当前通话是否保持

    • true：当前通话状态为保持
    • false：当前通话状态为正常

isOnewayVideo

  • isOnewayVideo(): boolean

  • 获取单向视频状态

    座席可可修改当前通话的单向视频状态。

    Returns boolean

    单向视频状态

    • true: 处于单向视频
    • false: 不处于单向视频

isMainGuest

  • isMainGuest(): boolean

  • 是否主访客

    Returns boolean

    • true 主访客
    • false 其他三方访客

getMainAgentParticipant

  • getMainAgentParticipant(): undefined | JRTCRoomParticipant

  • 获取主座席成员

    Returns undefined | JRTCRoomParticipant

    • 只有在通话中且通话中存在座席成员才能获得座席成员对象，否则为 undefined
    • 座席成员发起转接成功后，在新的座席对象接听通话前这段时间内，获取的值为 undefined

getAgentParticipants

  • getAgentParticipants(): JRTCRoomParticipant[]

  • 获取座席成员列表

    Returns JRTCRoomParticipant[]

    • 只有在通话中且通话中存在座席成员才能获得含有座席成员对象的数组，返回空数组
    • 当通话中不存在第三方座席时，数组中仅包含一个主座席成员对象
    • 当通话中存在第三方座席时，数组中包含主座席和第三方座席成员对象
    • 当通话中仅存在一个座席时，座席成员发起转接成功后，在新的座席对象接听通话前这段时间内，返回空数组

getSelfParticipant

getParticipants

getSerialNumber

  • getSerialNumber(): string

  • 获取服务唯一标识

    上层可使用该参数通过业务管理平台第三方接口查询到话务信息，如录制视频文件的URL

    Returns string

    服务唯一标识

getCallId

  • getCallId(): undefined | string

  • 获取通话唯一标识

    Returns undefined | string

    通话唯一标识

getShareStreamId

  • getShareStreamId(): undefined | string

  • 获取屏幕共享的视频流ID

    渲染通话中其他成员的屏幕共享画面时使用。

    Returns undefined | string

    • 有屏幕共享时返回屏幕共享的视频流ID
    • 无屏幕共享时返回 undefined

getShareUserId

  • getShareUserId(): undefined | string

  • 获取发起屏幕共享者的用户ID

    可用来判断当前通话中是否有成员发起屏幕共享。

    Returns undefined | string

    • 有屏幕共享时返回发起屏幕共享者的用户ID
    • 无屏幕共享时返回 undefined

setMultiStream

  • setMultiStream(multiStream): void

  • 设置是否使用多流，即每个通话成员单独一路媒体流(需要各自单独订阅和渲染)， 默认 fale 使用合流，所有成员媒体流合并在一路媒体流，只要订阅渲染成员 用户ID 为 “MERGED__” 的成员媒体流

    Parameters

    • multiStream: boolean

    Returns void

    Note

    1、目前主要针对 H5 生效，小程序只有合流；2、如果是呼出场景则优先使用呼叫参数中 multiStream 是否多流参数，该方法设置参数会被覆盖

    Apram

    multiStream 是否分流

queryAllGroups

  • queryAllGroups(): boolean

  • 获取业务号列表

    Returns boolean

    接口调用结果

    • true: 接口调用成功，返回结果通过 onGetAllGroups 回调上报
    • false: 接口调用异常

call

  • call(number, callParam?): boolean

  • 呼叫指定业务

    Parameters

    • number: string

      业务号，如10087，一般由业务管理人员在业务管理平台上配置业务，然后将业务号给开发人员

    • Optional callParam: JRTCCallCenterCallParam

      呼叫参数设置，可以设置通话分辨率、全局宽高比等参数，此参数不传则使用默认配置

    Returns boolean

    接口调用结果

    • true: 接口调用成功，通话状态会通过 onCallStateChanged 回调上报
    • false: 接口调用异常

oneToOneCall

  • oneToOneCall(userId, callParam?): boolean

  • 呼叫指定座席

    Parameters

    • userId: string

      座席 id，如agent1，一般由业务管理人员在业务管理平台上配置座席id，然后将座席id给开发人员

    • Optional callParam: JRTCCallCenterCallParam

      呼叫参数设置，可以设置通话分辨率、全局宽高比等参数，此参数不传则使用默认配置

    Returns boolean

    接口调用结果

    • true: 接口调用成功，通话状态会通过 onCallStateChanged 回调上报
    • false: 接口调用异常

answer

  • answer(): boolean

  • 接听通话邀请

    仅在作为第三方访客同意接听通话邀请时调用，其他情况不会用到此接口。

    Returns boolean

    接口调用结果

    • true: 接口调用成功，会接收到 onCallStateChanged 回调
    • false: 接口调用异常

term

  • term(): boolean

  • 结束通话

    Returns boolean

    接口调用结果

    • true: 接口调用成功，会收到 onCallStateChanged 回调
    • false: 接口调用异常

    Note

    • 主访客调用此接口会结束通话，通话中所有成员都会离开，此通通话销毁，所有成员会收到 onCallStateChanged 通话结束回调。
    • 第三方访客调用此接口仅自身离开通话，通话中其他成员会收到该成员离开的回调 onMemberLeave 回调，通话继续进行。

requestUrgent

  • requestUrgent(): boolean

  • 请求加急 请求加急流程:

    1. 访客在排队过程中调用此接口发起加急请求
    2. 管理员权限的座席（业务管理平台配置）收到 onUrgentRequest 回调
    3. 座席收到回调后调用 responseUrgent 接口对加急请求进行处理
    4. 座席处理后，访客会收到 onUrgentResultResponse 加急请求处理结果回调，如果座席同意加急请求，则将会插队到队列最前

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

sendMessage

  • sendMessage(contentType, content, toUserId): boolean

  • 发送消息，消息内容不能大于4K

    指定成员会收到 onMessageReceived 回调

    Parameters

    • contentType: string

      消息内容类型

    • content: string

      消息内容

    • toUserId: string

      指定成员的用户ID，传 null 给通话中全部成员发送消息

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

sendNotifyMessage

  • sendNotifyMessage(notifyMessage, toUserId?): boolean

  • 发送事件通知消息

    通话中的其他成员会收到 onNotifyMessageReceived 回调

    Parameters

    • notifyMessage: JRTCNotifyMessage

      事件通知实体对象

    • Optional toUserId: string

      指定成员的用户ID，不传即给通话中全部成员发送通知消息

    Returns boolean

    Returnss

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

enableUploadAudioStream

  • enableUploadAudioStream(enable): boolean

  • 开启/关闭发送本地音频流

    通话中调用该方法可开启或关闭发送本地音频流。开启后，通话中的成员将听见本端声音；关闭后，频道成员将听不见本端声音
    通话中调用此方法成功后，服务器会更新状态并同步给通话中所有成员，即所有成员会收到 onMemberUpdate 回调，具体可关注 audio
    通话中调用此方法不影响接收其他成员的音频流

    Parameters

    • enable: boolean

      开启/关闭发送本地音频流

      • true: 开启，即发送本地音频流
      • false: 关闭，即不发送本地音频流

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

enableUploadVideoStream

  • enableUploadVideoStream(enable): boolean

  • 开启/关闭发送本地视频流

    通话中调用该方法可开启或关闭发送本地视频流。开启后，通话中的成员将看见本端画面；关闭后，频道成员将看不见本端画面
    通话中调用此方法成功后，服务器会更新状态并同步给通话中所有成员，即所有成员会收到 onMemberUpdate 回调，具体可关注 video
    通话中调用此方法不影响接收其他成员的视频流

    Parameters

    • enable: boolean

      开启/关闭发送本地视频流

      • true: 开启，即发送本地视频流
      • false: 关闭，即不发送本地视频流

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

setRatio

  • setRatio(ratio): boolean

  • 设置本端视频宽高比

    将自己的视频采集根据宽高比裁剪后进行发送，通话中其他成员收到的画面将是裁剪后的比例。
    该方法不影响其他成员的画面在本端的显示比例，也不影响其他成员相互之间的画面显示比例。
    必须 开始通话后 设置才能生效，即收到 onCallStateChanged 回调且 type == TALKING 时设置才生效。

    Parameters

    • ratio: number

      视频宽高比

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

setRemoteMergeVideoProperty

  • setRemoteMergeVideoProperty(mergeParam): boolean

  • 设置远端视频合流参数

    Parameters

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

    Notes

    需要建立通话

getRequestSize

  • getRequestSize(): JRTCVideoSize

  • 获取视频请求尺寸

    影响自己看其他成员的视频分辨率

    Returns JRTCVideoSize

    视频请求尺寸

setRequestSize

  • setRequestSize(requestSize): void

  • 设置视频请求尺寸

    Parameters

    Returns void

    Note

    该接口目前不生效，请使用 #setRemoteMergeVideoProperty 来设置远端视频分辨率

    在渲染画面前设置才有效，建议在通话开始前设置。

unRequestVideo

  • unRequestVideo(participant): boolean

  • 取消订阅通话中其他成员的视频流

    Parameters

    Returns boolean

    接口调用结果

    • true: 接口调用成功，会收到 onMemberUpdate 回调，具体可关注 videoSize 属性
    • false: 接口调用异常

unRequestScreenVideo

  • unRequestScreenVideo(): boolean

  • 取消订阅通话中屏幕共享的视频流

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

enableRemoteRecord

  • enableRemoteRecord(enable, recordParam?): boolean

  • 开启/关闭远程视频录制

    可用过 getRemoteRecordState 接口获取当前服务器录制状态。

    Parameters

    • enable: boolean

      开启或关闭视频录制

      • true: 开启视频录制
      • false: 关闭视频录制
    • Optional recordParam: JRTCRecordRemoteParam

      录制参数，当 enable == false 时，可传 null；当 enable == true 且按照默认配置进行录制可传 null

    Returns boolean

    接口调用结果

getRemoteRecordState

  • getRemoteRecordState(): RemoteRecordState

  • 获取远程视频录制状态

    Returns RemoteRecordState

    远程视频录制状态

    • NONE : 无法进行视频录制。用户不在频道中或者加入频道时没有设置视频录制参数
    • READY : 可以开启视频录制。用户在加入频道时设置了录制参数，并且没有在录制视频
    • RUNNING : 视频录制中。用户在加入频道时设置了录制参数，并且正在视频录制中

responseSignResult

  • responseSignResult(result, userId, extraInfo): boolean

  • 响应座席签名请求

    请求访客签名流程:

    1. 座席调用此接口向指定访客发送签名请求
    2. 座席调用成功后，访客会收到 onSignRequest 回调
    3. 访客进行签名，并将签名图片上传至业务管理平台（需要应用层自行实现）
    4. 访客响应座席签名结果

    Parameters

    • result: boolean

      签名结果

      • true: 签名成功
      • false: 签名失败
    • userId: string

      需要响应签名请求结果的座席用户ID

    • extraInfo: string

      随路额外消息

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

statistics

  • statistics(): string

  • Returns string

    统计信息

设置

主题

Generated using TypeDoc