Class JRTCAgentAbstract

座席管理

Hierarchy

  • JRTCModuleBase
    • JRTCAgent

Methods

create destroy destroyObj isAutoRecord getCallState getCallType isOnewayVideo getHoldState setHoldState getTermState setTermState getOperatorState isPause isMainAgent getMainGuestParticipant getGuestParticipants getSelfParticipant getParticipants getSerialNumber getCallId getStatistics getJsonStats getSupportVideoSizes setUseExternalScreenCaptureControl queryAllGroups queryAvailableAgentList checkin checkout joinCall recall answer term applyStatePause transferCall turnCallType turnCallTypeForSip inviteThirdGuest inviteThirdAgent switchPartRole kickParticipant requestSign requestOnewayVideo responseUrgent sendMessage sendNotifyMessage enableUploadAudioStream enableUploadVideoStream getUploadLocalAudio getUploadLocalVideo sendAudioEmptyPack sendVideoEmptyPack enableScreenShare suspendScreenShare isSuspendScreenShare getShareStreamId getShareUserId setRatio getRequestSize setRequestSize requestVideo unRequestVideo requestScreenVideo unRequestScreenVideo controlRecord enableLocalRecord updateLocalRecordLayout isLocalRecording enableRemoteRecord updateRemoteRecordLayout updateRemoteRecordWatermark getRemoteRecordState setVideoDot setSubScreenShare isSubScreenShare enableMicAgc addCallback removeCallback startBiz onBizBegin onBizEnd

Methods

Staticcreate

  • create(
        client: JRTCClient,
        mediaDevice: JRTCMediaDevice,
        callback: JRTCAgentCallback,
    ): JRTCAgent

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

    Parameters

    Returns JRTCAgent

    JRTCAgent 对象

    Throws

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

    Remarks

    • JRTCAgent 的所有接口函数，如无特殊说明，都建议再主线程调用
    • 请确保在调用其他 API 前先调用该方法创建并初始化 JRTCClient 对象，JRTCMediaDevice 对象
    • 调用此方法前确保 JRTCClient 已完成初始化，即 state 方法获取的状态值不等于 JRTCClient#STATE_NOT_INIT STATE_NOT_INIT
    • 调用此方法创建 JRTCAgent 对象后，期间没有调用过 #destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JRTCAgent 对象

Staticdestroy

  • destroy(): void

  • 销毁 JRTCAgent 对象

    Returns void

    Remarks

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

AbstractdestroyObj

  • destroyObj(): any

  • 销毁对象

    Returns any

AbstractisAutoRecord

  • isAutoRecord(): boolean

  • 是否由服务器自动开启录制

    由访客 autoRecord 属性决定，在通话状态为 JRTCCallCenter#CALL_STATE_TALKING CALL_STATE_TALKING 时可以获取
    如果当前为自动录制模式，即 isAutoRecord == true，则座席的 #controlRecord 远程录制接口不生效

    Returns boolean

AbstractgetCallState

  • getCallState(): number

  • 获取当前通话状态

    Returns number

    当前通话状态

AbstractgetCallType

  • getCallType(): number

  • 获取当前通话类型

    可通过 #turnCallType 接口修改当前通话类型。

    Returns number

    当前通话类型

    • JRTCCallCenter#CALL_TYPE_AUDIO CALL_TYPE_AUDIO：语音通话
    • JRTCCallCenter#CALL_TYPE_VIDEO CALL_TYPE_VIDEO：视频通话

AbstractisOnewayVideo

  • isOnewayVideo(): boolean

  • 获取单向视频状态

    座席可调用 : requestOnewayVideo 接口修改当前通话的单向视频状态。

    Returns boolean

    单向视频状态

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

AbstractgetHoldState

  • getHoldState(): boolean

  • 获取当前通话保持状态

    座席可调用 #setHoldState setHoldState 接口修改当前通话的保持状态。

    Returns boolean

    当前通话是否保持

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

AbstractsetHoldState

  • setHoldState(hold: boolean): boolean

  • 保持/取回

    可以通过 #getHoldState getHoldState 获取当前通话保持状态
    保持通话后双方互相停止音视频流的发送与接收

    Parameters

    • hold: boolean

      保持或取回 - true: 设置为保持状态 - false: 设置为取回状态

    Returns boolean

    接口调用结果

    • true: 接口调用成功，通话中的所有成员将会收到 JRTCGuestCallback#onHoldStateChanged onHoldStateChanged 或 onHoldStateChanged 回调
    • false: 接口调用异常

AbstractgetTermState

AbstractsetTermState

  • setTermState(state: JRTCCallCenterTermState): any

  • 设置通话结束后示闲/示忙状态，默认为示闲状态

    Parameters

    Returns any

AbstractgetOperatorState

AbstractisPause

  • isPause(): boolean

  • 获取示忙/示闲状态

    调用 #checkIn(int) 或 #checkIn(String, int) 接口签入，状态为示闲
    调用 #checkIn(String, int, boolean) 接口签入，状态与 busy 参数一致
    调用 #applyStatePause 接口主动发起示忙示闲，状态与 pause 参数一致

    Returns boolean

    示忙/示闲状态

    • true: 示忙状态
    • false: 示闲状态

AbstractisMainAgent

  • isMainAgent(): boolean

  • 是否主座席

    Returns boolean

    • true 主座席
    • false 其他三方座席

AbstractgetMainGuestParticipant

  • getMainGuestParticipant(): JRTCRoomParticipant

  • 获取主访客成员

    Returns JRTCRoomParticipant

    • 通话中返回访客成员对象
    • 不在通话中返回 undefined

AbstractgetGuestParticipants

  • getGuestParticipants(): ArrayList<JRTCRoomParticipant>

  • 获取访客成员列表

    Returns ArrayList<JRTCRoomParticipant>

    • 只有在通话中且通话中才能获得含有访客成员对象的数组，否则为空数组
    • 当通话中不存在第三方访客时，获得一个仅含有主访客成员对象的数组
    • 当通话中存在第三方访客时，获得一个含有主访客和第三方访客成员对象的数组

AbstractgetSelfParticipant

AbstractgetParticipants

  • getParticipants(): any

  • 获取所有成员 (包含自己、访客和其他座席)

    Returns any

    所有成员对象

AbstractgetSerialNumber

  • getSerialNumber(): string

  • 获取业务唯一标识

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

    Returns string

    业务唯一标识

AbstractgetCallId

  • getCallId(): string

  • 获取通话唯一标识

    Returns string

    通话唯一标识

AbstractgetStatistics

  • getStatistics(): string

  • 获取统计信息

    以字符串形式返回，其中包含 "Config"， "Network"，"Transport" 和 "Participants" 4个节点:

    Returns string

    Verbatim

    Endverbatim

AbstractgetJsonStats

  • getJsonStats(): string

  • 获取实时统计信息

    以Json字符串形式返回，包含以下信息:

    Returns string

    Verbatim

    Endverbatim

AbstractgetSupportVideoSizes

  • getSupportVideoSizes(): any

  • 获取该通话支持的视频分辨率列表

    Returns any

    通话视频分辨率列表

AbstractsetUseExternalScreenCaptureControl

  • setUseExternalScreenCaptureControl(useExternalControl: boolean): any

  • 设置是否由应用层自行控制屏幕采集逻辑，默认 false，由 SDK 内部根据通话业务开始/结束自动控制屏幕采集开启/关闭逻辑，比如通话建立时开启屏幕共享自动开启屏幕采集，关闭屏幕共享或者通话结束时自动关闭屏幕采集。

    Parameters

    • useExternalControl: boolean

      是否由应用层自行控制屏幕采集逻辑 - true 由应用层自行调用 (boolean) enableScreenCapture 接口控制屏幕采集开启/关闭逻辑。 - false 由 SDK 内部根据通话业务开始/结束自动控制屏幕采集开启/关闭逻辑。

    Returns any

AbstractqueryAllGroups

  • queryAllGroups(): boolean

  • 获取业务号列表

    Returns boolean

    接口调用结果

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

AbstractqueryAvailableAgentList

  • queryAvailableAgentList(businessNumber: string): number

  • 查询指定业务号的空闲座席

    查询结果通过 onQueryAvailableAgentList 回调上报

    Parameters

    • businessNumber: string

      业务号，例如 10087

    Returns number

    操作id，与 onQueryAvailableAgentList 的 operationId 参数对应

Abstractcheckin

  • checkin(
        userId: string,
        busy: boolean,
        checkInParam: JRTCAgentCheckinParam,
    ): boolean

  • 签入

    签入到排队机，签入后示忙/示闲状态由 busy 参数决定
    示闲状态下正常呼叫进线
    调用接口前确定 JRTCClient 登录成功
    调用该接口前需先确定 #getOperatorState operatorState 来获取到当前的签入状态

    Parameters

    • userId: string

      座席用户ID，需与业务管理平台上配置的座席staffId对应，如果传空，则默认用当前登录用户ID签入

    • busy: boolean

      签入后示忙/示闲状态 - true: 示忙 - false: 示闲

    • checkInParam: JRTCAgentCheckinParam

    Returns boolean

    接口调用结果

    • true: 接口调用成功，签入结果会触发 onCheckin 回调上报
    • false: 接口调用异常

Abstractcheckout

  • checkout(): boolean

  • 签出

    签出后将不会收到排队机的呼叫分配
    签出排队机不影响 JRTCClient 的登录状态
    调用 #getOperatorState operatorState 可获取当前签入状态

    Returns boolean

    接口调用结果

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

AbstractjoinCall

  • joinCall(serialNumber: string, partRole: JRTCCallCenterRole): boolean

  • 加入通话

    Parameters

    • serialNumber: string

      业务唯一标识

    • partRole: JRTCCallCenterRole

      加入通话成员角色

    Returns boolean

    接口调用结果

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

    Remarks

    需要先签入并且示闲，目前只支持以观察者座席和次座席角色加入

    See

    • #AGENT 次座席
    • #VIEWER_AGENT 观察者（次座席），无感入会

Abstractrecall

  • recall(userId: string, callParam: JRTCCallCenterCallParam): boolean

  • 座席回呼 *

    Parameters

    Returns boolean

    接口调用结果

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

    Remarks

    需要先签入并且示闲

Abstractanswer

  • answer(): boolean

  • 接听

    主座席、第三方座席或是被转接的座席，都调用此接口接听通话

    Returns boolean

    接口调用结果

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

Abstractterm

  • term(): boolean

  • 结束通话

    来电过程中调用此接口拒绝接听，访客分配到其他座席继续呼叫等待不会挂断。
    主座席调用此接口会结束通话，通话中所有成员都会离开，此通通话销毁，所有成员会收到 onCallStateChanged 或 JRTCGuestCallback#onCallStateChanged onCallStateChanged 通话结束回调。
    第三方座席调用此接口仅自身离开通话，通话中其他成员会收到该成员离开的回调 JRTCGuestCallback#onMemberLeave onMemberLeave 或 onMemberLeave 回调，通话继续进行。

    Returns boolean

    接口调用结果

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

AbstractapplyStatePause

  • applyStatePause(pause: boolean): number

  • 示忙/示闲

    示忙状态下不会收到呼叫来电，示闲状态下正常呼叫进线
    通话过程中调用该接口不会影响当前通话，从下个通话开始状态生效
    示忙/示闲的结果通过 onApplyResult 回调上报

    Parameters

    • pause: boolean

      示忙或是示闲 - true: 示忙 - false: 示闲

    Returns number

    接口调用结果

    • 0: 操作id，对应 onApplyResult 回调的 operationId 参数

    • -1:接口调用异常
  • applyStatePause(pause: boolean, subState: number): number

  • 示忙/示闲

    示忙状态下不会收到呼叫来电，示闲状态下正常呼叫进线
    通话过程中调用该接口不会影响当前通话，从下个通话开始状态生效
    示忙/示闲的结果通过 onApplyResult 回调上报

    Parameters

    • pause: boolean

      示忙或是示闲 - true: 示忙 - false: 示闲

    • subState: number

      子状态，报表数据统计需要，取值[0, 9] - 0: 默认子状态 - 1~9: 自定义子状态

    Returns number

    接口调用结果

    • 0: 操作id，对应 onApplyResult 回调的 operationId 参数

    • -1:接口调用异常

AbstracttransferCall

  • transferCall(type: JRTCCallCenterTransferType, id: string): number

  • 通话转接

    支持转接到具体座席和转接到某个业务组

    Parameters

    • type: JRTCCallCenterTransferType

      转接类型，转接到具体座席或是转接到业务组 - JRTCCallCenterTransferType#GROUP GROUP 转接到业务组 - JRTCCallCenterTransferType#STUFF STUFF 转接到具体座席

    • id: string

      当转接类型为 JRTCCallCenterTransferType#GROUP GROUP 时，id 需传入业务组号 - 当转接类型为 JRTCCallCenterTransferType#STUFF STUFF 时，id 需传入座席用户ID

    Returns number

    接口调用结果

    Remarks

    直呼场景接通后，不支持通话转接 转接结果通过 onTransferCallResult 回调上报
    座席调用转接接口成功时，访客会收到 JRTCGuestCallback#onCallForwarding onCallForwarding 回调

AbstractturnCallType

  • turnCallType(callType: JRTCCallCenterCallType): any

  • 音视频通话切换

    可以通过 #getCallType 接口获取当前的通话类型
    通话中所有成员都将收到JRTCGuestCallback#onCallTypeChanged onCallTypeChanged 或 onCallTypeChanged 回调

    Parameters

    Returns any

    当前通话类型

    • JRTCCallCenterCallType#AUDIO AUDIO：语音通话
    • JRTCCallCenterCallType#VIDEO VIDEO：视频通话

AbstractturnCallTypeForSip

  • turnCallTypeForSip(
        callType: JRTCCallCenterCallType,
        userId: string,
        extraInfo: string,
    ): boolean

  • 请求音视频通话切换

    Parameters

    • callType: JRTCCallCenterCallType

      通话类型 当前通话类型

      • JRTCCallCenterCallType#AUDIO AUDIO：语音通话
      • JRTCCallCenterCallType#VIDEO VIDEO：视频通话（目前仅支持此类型）
    • userId: string

      用户id

    • extraInfo: string

      随路参数

    Returns boolean

    接口调用是否成功

    Remarks

    目前仅支持Sip通话情况下，请求Sip成员开启视频

AbstractinviteThirdGuest

  • inviteThirdGuest(userId: string, extraInfo: string): boolean

  • 邀请第三方访客加入

    被邀请的第三方座席会收到 onCallStateChanged 来电邀请回调
    第三方访客接听通话后，已在通话中的成员会收到 onMemberJoin 或 JRTCGuestCallback#onMemberJoin onMemberJoin 成员加入回调

    Parameters

    • userId: string

      要邀请的第三方访客用户ID

    • extraInfo: string

      邀请携带的随路信息

    Returns boolean

    接口调用结果

  • inviteThirdGuest(
        userId: string,
        extraInfo: string,
        inviteParam: JRTCCallCenterInviteParam,
    ): boolean

  • 邀请第三方访客加入

    被邀请的第三方座席会收到 onCallStateChanged 来电邀请回调
    第三方访客接听通话后，已在通话中的成员会收到 onMemberJoin 或 JRTCGuestCallback#onMemberJoin onMemberJoin 成员加入回调

    Parameters

    • userId: string

      要邀请的第三方访客用户ID

    • extraInfo: string

      邀请携带的额外信息

    • inviteParam: JRTCCallCenterInviteParam

      邀请的其他参数

    Returns boolean

    接口调用结果

AbstractinviteThirdAgent

  • inviteThirdAgent(userId: string): boolean

  • 邀请第三方座席加入

    被邀请的第三方座席会收到 onCallStateChanged 来电邀请回调
    第三方座席接听通话后，已在通话中的成员会收到 onMemberJoin 或 JRTCGuestCallback#onMemberJoin onMemberJoin 成员加入回调

    Parameters

    • userId: string

      要邀请的座席用户ID

    Returns boolean

    接口调用结果

AbstractswitchPartRole

  • switchPartRole(partRole: JRTCCallCenterRole): number

  • 切换自己在通话中角色

    Parameters

    Returns number

    接口调用结果

    Remarks

    需要先进入通话，目前只支持从观察者座席角色切换到主座席角色

    See

    • JRTCCallCenterRole#MAIN_AGENT 主座席
    • JRTCCallCenterRole#AGENT 次座席

AbstractkickParticipant

  • kickParticipant(userId: string): number

  • 踢出通话成员

    Parameters

    • userId: string

      成员用户ID

    Returns number

    接口调用结果

    Remarks

    只有主座席角色可以使用该功能

AbstractrequestSign

  • requestSign(userId: string, extraInfo: string): boolean

  • 请求访客签名

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

    Parameters

    • userId: string

      需要请求签名的访客用户ID

    • extraInfo: string

      随路额外消息

    Returns boolean

    接口调用结果

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

AbstractrequestOnewayVideo

  • requestOnewayVideo(turnOn: boolean): any

  • 请求单向视频

    座席调用此接口后，会向全体访客发送单向视频请求，访客会收到 JRTCGuestCallback#onOnewayVideoChanged onOnewayVideoChanged 回调
    应用需要自行实现单向视频功能，例如访客用图片遮挡该座席画面，SDK不会对画面进行单向处理

    Parameters

    • turnOn: boolean

      打开或关闭单向视频 - true: 打开单向视频 - false: 关闭单向录制

    Returns any

AbstractresponseUrgent

  • responseUrgent(
        serialNumber: string,
        callerNumber: string,
        agree: boolean,
    ): number

  • 处理加急请求

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

    Parameters

    • serialNumber: string

      业务唯一标识，通过 onUrgentRequest 回调获得

    • callerNumber: string

      发起加急请求的用户ID，通过 onUrgentRequest 回调获得

    • agree: boolean

      同意或拒绝加急请求 - true: 同意加急请求 - false: 拒绝加急请求

    Returns number

    操作id，对应 onResponseUrgentResult 回调的 operationId 参数

AbstractsendMessage

  • sendMessage(contentType: string, content: string, toUserId: string): boolean

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

    指定成员会收到 JRTCGuestCallback#onMessageReceived onMessageReceived 或 onMessageReceived 回调

    Parameters

    • contentType: string

      消息内容类型

    • content: string

      消息内容

    • toUserId: string

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

    Returns boolean

    接口调用结果

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

AbstractsendNotifyMessage

  • sendNotifyMessage(notifyMessage: JRTCNotifyMessage, toUserId: string): boolean

  • 发送事件通知消息

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

    Parameters

    • notifyMessage: JRTCNotifyMessage

      事件通知实体对象

    • toUserId: string

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

    Returns boolean

    接口调用结果

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

AbstractenableUploadAudioStream

  • enableUploadAudioStream(enable: boolean): boolean

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

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

    Parameters

    • enable: boolean

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

    Returns boolean

    接口调用结果

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

AbstractenableUploadVideoStream

  • enableUploadVideoStream(enable: boolean): boolean

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

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

    Parameters

    • enable: boolean

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

    Returns boolean

    接口调用结果

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

AbstractgetUploadLocalAudio

  • getUploadLocalAudio(): boolean

  • 获取本地音频数据是否在上传

    Returns boolean

    是否上传音频数据

    • true: 上传中
    • false: 未上传

AbstractgetUploadLocalVideo

  • getUploadLocalVideo(): boolean

  • 获取本地视频数据是否在上传

    Returns boolean

    是否在上传本地视频数据

    • true: 上传中
    • false: 未上传

AbstractsendAudioEmptyPack

  • sendAudioEmptyPack(empty: boolean): boolean

  • 发送音频空包

    该接口不会导致成员的 JRTCRoomParticipant.ChangeParam#audio audio 属性变化，发送音频空包不代表停止发送音频流。一般用于座席保持通话后使用。

    Parameters

    • empty: boolean

      音频发送包是否为空包 - true:发送音频空包 - false:发送正常音频包

    Returns boolean

    接口调用结果

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

AbstractsendVideoEmptyPack

  • sendVideoEmptyPack(empty: boolean): boolean

  • 发送视频空包

    该接口不会导致成员的 JRTCRoomParticipant.ChangeParam#video video 属性变化，发送视频空包不代表停止发送视频流。一般用于座席保持通话后使用。

    Parameters

    • empty: boolean

      视频发送包是否为空包 - true:发送视频空包 - false:发送正常视频包

    Returns boolean

    接口调用结果

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

AbstractenableScreenShare

  • enableScreenShare(
        enable: boolean,
        sendScreenParam?: JRTCSendScreenParam,
    ): boolean

  • 开启/关闭屏幕共享

    Parameters

    • enable: boolean

      开启或关闭屏幕共享 - true: 开启屏幕共享 - false: 关闭屏幕共享

    • OptionalsendScreenParam: JRTCSendScreenParam

    Returns boolean

    接口调用结果

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

    Remarks

    如果 #setUseExternalScreenCaptureControl(boolean) setUseExternalScreenCaptureControl 为 true, 则该接口只负责信令通知，请确保开启屏幕共享前，已经开启了屏幕采集，否则远端用户收到屏幕共享画面为黑屏

    成员开启或关闭屏幕共享，通话中的所有成员会收到 onCallPropertyChanged 或 onCallPropertyChanged 回调。

AbstractsuspendScreenShare

  • suspendScreenShare(suspend: boolean, tip: string): boolean

  • 暂停/继续屏幕共享

    Parameters

    • suspend: boolean

      true 暂停屏幕共享， false 继续屏幕共享

    • tip: string

      暂停屏幕共享后提示文字

    Returns boolean

    接口调用结果

    • true: 接口调用成功, 会收到 onCallPropertyChanged 回调，可通过#isSuspendScreenShare isSuspendScreenShare 判断当前屏幕共享是否暂停
    • false: 接口调用异常

    Remarks

    只有自己发起的屏幕共享可以使用该接口暂停，多次调用会覆盖

AbstractisSuspendScreenShare

  • isSuspendScreenShare(): boolean

  • 是否屏幕共享暂停

    Returns boolean

    • true: 暂停屏幕共享
    • false: 未暂停屏幕共享

AbstractgetShareStreamId

  • getShareStreamId(): string

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

    调用 JRTCMediaDevice#startVideo startVideo 接口渲染通话中其他成员的屏幕共享画面时使用。

    Returns string

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

AbstractgetShareUserId

  • getShareUserId(): string

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

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

    Returns string

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

AbstractsetRatio

  • setRatio(ratio: number): boolean

  • 设置本端视频宽高比

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

    Parameters

    • ratio: number

      视频宽高比

    Returns boolean

    接口调用结果

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

AbstractgetRequestSize

  • getRequestSize(): JRTCVideoSize

  • 获取视频请求尺寸

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

    Returns JRTCVideoSize

    视频请求尺寸

AbstractsetRequestSize

  • setRequestSize(requestSize: JRTCVideoSize): any

  • 设置视频请求尺寸

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

    Parameters

    Returns any

AbstractrequestVideo

  • requestVideo(
        participant: JRTCRoomParticipant,
        videoSize: JRTCVideoSize,
    ): boolean

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

    Parameters

    Returns boolean

    接口调用结果

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

AbstractunRequestVideo

  • unRequestVideo(participant: JRTCRoomParticipant): boolean

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

    Parameters

    Returns boolean

    接口调用结果

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

AbstractrequestScreenVideo

  • requestScreenVideo(videoSize: JRTCVideoSize): boolean

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

    Parameters

    Returns boolean

    接口调用结果

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

AbstractunRequestScreenVideo

  • unRequestScreenVideo(): boolean

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

    Returns boolean

    接口调用结果

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

AbstractcontrolRecord

  • controlRecord(
        action: JRTCCallCenterRecordAction,
        recordParam: JRTCRecordControlParam,
    ): boolean

  • 开启/关闭远程录制

    仅在 #isAutoRecord == false 时调用接口有效，即访客发起呼叫时，呼叫参数 JRTCCallCenterCallParam#autoRecord 需要为 false 。
    由服务器自动开启远程录制，即 #isAutoRecord == true 时，水印内容由业务管理平台配置。
    调用接口手动开启远程录制时，水印内容由参数 recordParam.watermarkTextMap 决定。

    Parameters

    • action: JRTCCallCenterRecordAction

      打开或停止录制 - JRTCCallCenterRecordAction#START START : 打开录制 - JRTCCallCenterRecordAction#STOP STOP : 停止录制

    • recordParam: JRTCRecordControlParam

      录制参数对象

    Returns boolean

    接口调用结果

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

AbstractenableLocalRecord

  • enableLocalRecord(enable: boolean, recordParam: JRTCRecordLocalParam): boolean

  • 开启/关闭本地录制

    Parameters

    • enable: boolean

      开启或关闭本地录制 - true: 开启本地录制 - false: 关闭本地录制

    • recordParam: JRTCRecordLocalParam

      本地录制参数配置，当 enable == true 时，JRTCRecordLocalParam#filePath 必须设置，其余参数不设置则使用默认配置；当 enable == false 时，recordParam 可传 undefined

    Returns boolean

    接口调用结果

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

    Remarks

    确保调用接口前本地录制文件所在目录已经存在，否则会录制失败

AbstractupdateLocalRecordLayout

  • updateLocalRecordLayout(layoutList: ArrayList<JRTCRecordLocalLayout>): boolean

  • 更新本地录制自定义布局

    Parameters

    • layoutList: ArrayList<JRTCRecordLocalLayout>

      需要更新的布局列表

    Returns boolean

    接口调用结果

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

AbstractisLocalRecording

  • isLocalRecording(): boolean

  • 是否正在本地录制

    Returns boolean

    是否正在本地录制

    • true: 正在本地录制中
    • false: 未进行本地录制

AbstractenableRemoteRecord

  • enableRemoteRecord(enable: boolean, recordParam: JRTCRecordRemoteParam): boolean

  • 开启/关闭远程录制

    当呼叫参数 autoRecord == false 时，可通过此接口开启服务端录制。
    可用过 #getRemoteRecordState 接口获取当前服务器录制状态。

    Parameters

    • enable: boolean

      开启或关闭远程录制 - true: 开启视频录制 - false: 关闭视频录制

    • recordParam: JRTCRecordRemoteParam

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

    Returns boolean

    接口调用结果

    • true: 接口调用成功，录制状态通过 onCallPropertyChanged 回调获得，具体可关注 JRTCRoom.PropChangeParam#remoteRecordState remoteRecordState
    • false: 接口调用异常

AbstractupdateRemoteRecordLayout

  • updateRemoteRecordLayout(layoutList: ArrayList<JRTCRecordRemoteLayout>): boolean

  • 更新远程录制自定义布局

    Parameters

    • layoutList: ArrayList<JRTCRecordRemoteLayout>

      需要更新的布局列表

    Returns boolean

    接口调用结果

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

AbstractupdateRemoteRecordWatermark

  • updateRemoteRecordWatermark(watermarkTextMap: HashMap<string, string>): boolean

  • 更新远程录制水印信息

    Parameters

    • watermarkTextMap: HashMap<string, string>

      水印信息

    Returns boolean

    接口调用结果

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

AbstractgetRemoteRecordState

  • getRemoteRecordState(): JRTCRemoteRecordState

  • 获取远程视频录制状态

    Returns JRTCRemoteRecordState

    远程视频录制状态，详见 JRTCRemoteRecordState

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

AbstractsetVideoDot

  • setVideoDot(timespan: string, info: string): boolean

  • 视频打点

    Parameters

    • timespan: string

      时间戳

    • info: string

      打点信息

    Returns boolean

    接口调用结果

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

AbstractsetSubScreenShare

  • setSubScreenShare(enable: boolean): boolean

  • 设置是否订阅屏幕共享

    Parameters

    • enable: boolean

      是否订阅屏幕共享

    Returns boolean

    接口调用结果

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

AbstractisSubScreenShare

  • isSubScreenShare(): boolean

  • 获取是否订阅屏幕共享

    Returns boolean

    返回屏幕共享是否订阅

AbstractenableMicAgc

  • enableMicAgc(enable: boolean): boolean

  • 开启或关闭本地麦克风的增益（软件增益）,默认开启

    Parameters

    • enable: boolean

      回调对象

    Returns boolean

    接口调用结果

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

    Remarks

    需要在建立通话后调用

AbstractaddCallback

  • addCallback(callback: JRTCAgentCallback): any

  • 添加回调

    Parameters

    Returns any

AbstractremoveCallback

  • removeCallback(callback: JRTCAgentCallback): any

  • 删除回调

    Parameters

    Returns any

startBiz

  • startBiz(): void

  • 发起业务

    Returns void

onBizBegin

  • onBizBegin(eventCode: number): void

  • 业务成功开始

    Parameters

    • eventCode: number

      事件码

    Returns void

onBizEnd

  • onBizEnd(eventCode: number): void

  • 业务结束

    Parameters

    • eventCode: number

      事件码

    Returns void

Settings

Member Visibility

On This Page

Methods
createdestroydestroyObjisAutoRecordgetCallStategetCallTypeisOnewayVideogetHoldStatesetHoldStategetTermStatesetTermStategetOperatorStateisPauseisMainAgentgetMainGuestParticipantgetGuestParticipantsgetSelfParticipantgetParticipantsgetSerialNumbergetCallIdgetStatisticsgetJsonStatsgetSupportVideoSizessetUseExternalScreenCaptureControlqueryAllGroupsqueryAvailableAgentListcheckincheckoutjoinCallrecallanswertermapplyStatePausetransferCallturnCallTypeturnCallTypeForSipinviteThirdGuestinviteThirdAgentswitchPartRolekickParticipantrequestSignrequestOnewayVideoresponseUrgentsendMessagesendNotifyMessageenableUploadAudioStreamenableUploadVideoStreamgetUploadLocalAudiogetUploadLocalVideosendAudioEmptyPacksendVideoEmptyPackenableScreenSharesuspendScreenShareisSuspendScreenSharegetShareStreamIdgetShareUserIdsetRatiogetRequestSizesetRequestSizerequestVideounRequestVideorequestScreenVideounRequestScreenVideocontrolRecordenableLocalRecordupdateLocalRecordLayoutisLocalRecordingenableRemoteRecordupdateRemoteRecordLayoutupdateRemoteRecordWatermarkgetRemoteRecordStatesetVideoDotsetSubScreenShareisSubScreenShareenableMicAgcaddCallbackremoveCallbackstartBizonBizBeginonBizEnd