Class JRTCGuestAbstract

访客管理类，提供访客相关的所有功能操作 JRTCGuest

Remarks

JRTCGuest类是访客管理的核心类，提供了访客呼叫、通话控制、音视频控制等完整功能。 该类采用单例模式设计，通过静态create方法创建实例。

Hierarchy

  • JRTCModuleBase
    • JRTCGuest

Methods

create destroy getCallState getCallType getHoldState isOnewayVideo isMainGuest getMainAgentParticipant getAgentParticipants getSelfParticipant getParticipant getParticipants getRoomId getSerialNumber getCallId getStatistics getJsonStats getSupportVideoSizes setUseExternalScreenCaptureControl queryAllGroups call callAgent oneToOneCall directCall answer term requestUrgent responseSignResult turnCallType sendMessage sendNotifyMessage enableUploadAudioStream enableUploadVideoStream getUploadLocalAudio getUploadLocalVideo sendAudioEmptyPack sendVideoEmptyPack enableScreenShare suspendScreenShare isSuspendScreenShare getShareStreamId getShareUserId setRatio getRequestSize setRequestSize requestVideo unRequestVideo requestScreenVideo unRequestScreenVideo createExtraStream deleteExtraStream requestExtraStreamVideo unRequestExtraStreamVideo enableLocalRecord updateLocalRecordLayout isLocalRecording enableRemoteRecord updateRemoteRecordLayout updateRemoteRecordWatermark getRemoteRecordState setVideoDot enableMicAgc setSubScreenShare isSubScreenShare startBiz onBizBegin onBizEnd

Methods

Staticcreate

  • create(
        client: JRTCClient,
        mediaDevice: JRTCMediaDevice,
        callback: JRTCGuestCallback,
    ): undefined | JRTCGuest

    创建JRTCGuest实例

    Parameters

    • client: JRTCClient

      JRTCClient实例，用于管理客户端基础功能

    • mediaDevice: JRTCMediaDevice

      JRTCMediaDevice实例，用于管理音视频设备

    • callback: JRTCGuestCallback

      回调接口，用于接收座席相关事件通知

    Returns undefined | JRTCGuest

    返回JRTCGuest实例，如果创建失败则返回undefined

    Throws

    当首次创建时任一参数为空时抛出异常

    Remarks

    • 该方法为单例模式，重复调用会返回同一实例
    • 所有接口函数建议在主线程调用
    • 调用前需确保JRTCClient已完成初始化
    • 如果JRTCClient未初始化（state === NOT_INIT)，将返回undefined

    Example

    const guest = JRTCGuest.create(client, mediaDevice, callback);
    if (guest) {
      // 创建成功，可以进行后续操作
    }

Staticdestroy

  • destroy(): void

    销毁JRTCGuest实例

    Returns void

    Remarks

    • 释放JRTCGuest实例及其占用的所有资源
    • 该方法为同步调用，会等待资源释放完成
    • 调用后无法再使用JRTCGuest的其他方法和回调
    • 不建议在JRTCSDK的回调中调用此方法，可能导致崩溃
    • 如需重新创建实例，需等待destroy方法执行完成

    Example

    JRTCGuest.destroy();
    // 等待资源释放完成后，才能重新创建实例

AbstractgetCallState

AbstractgetCallType

AbstractgetHoldState

  • getHoldState(): boolean

    获取当前通话保持状态

    Returns boolean

    当前通话是否处于保持状态

    Remarks

    • true: 当前通话处于保持状态
    • false: 当前通话处于正常状态 保持通话后双方互相停止音视频流的发送与接收

AbstractisOnewayVideo

  • isOnewayVideo(): boolean

    获取单向视频状态

    Returns boolean

    是否处于单向视频状态

    Remarks

    • true: 当前处于单向视频状态
    • false: 当前不处于单向视频状态

    座席可通过 JRTCAgent.requestOnewayVideo requestOnewayVideo 接口修改当前通话的单向视频状态

AbstractisMainGuest

  • isMainGuest(): boolean

    判断当前访客是否为主访客

    Returns boolean

    是否为主访客

    Remarks

    • true: 当前访客为主访客
    • false: 当前访客为其他三方访客

AbstractgetMainAgentParticipant

  • getMainAgentParticipant(): undefined | JRTCRoomParticipant

    获取主座席成员信息

    Returns undefined | JRTCRoomParticipant

    主座席成员对象，如果不在通话中则返回undefined

    Remarks

    主座席是指发起本次通话的座席，区别于后续可能加入的其他座席

AbstractgetAgentParticipants

  • getAgentParticipants(): any

    获取所有座席成员列表

    Returns any

    座席成员对象数组

    Remarks

    返回结果说明：

    • 不在通话中时返回空数组
    • 当通话中不存在第三方座席时，数组中只包含主座席成员
    • 当通话中存在第三方座席时，数组包含主座席和所有第三方座席

AbstractgetSelfParticipant

  • getSelfParticipant(): undefined | JRTCRoomParticipant

    获取当前访客自己的成员信息

    Returns undefined | JRTCRoomParticipant

    当前访客的成员对象

    Remarks

    可用于获取自己在通话中的角色、状态等信息

AbstractgetParticipant

  • getParticipant(userId: string): undefined | JRTCRoomParticipant

    根据用户标识获取房间成员

    Parameters

    • userId: string

      用户唯一标识，用于查询特定用户

    Returns undefined | JRTCRoomParticipant

    指定用户ID的参与者对象

    • 找到指定用户时返回 JRTCRoomParticipant 对象
    • 未找到指定用户或未加入通话时返回 undefined

    Remarks

    此方法用于在通话中查找并获取指定用户ID的参与者对象。 可用于获取特定用户的音视频状态或进行一对一操作。

AbstractgetParticipants

  • getParticipants(): any

    获取通话中的所有成员列表

    Returns any

    所有成员对象的数组

    Remarks

    返回的列表包含：

    • 当前访客自己
    • 所有座席成员
    • 其他访客成员

AbstractgetRoomId

  • getRoomId(): undefined | string

    获取房间号

    Returns undefined | string

    当前通话的房间号

AbstractgetSerialNumber

  • getSerialNumber(): undefined | string

    获取业务唯一标识

    Returns undefined | string

    业务唯一标识字符串

    Remarks

    • 该标识可用于通过业务管理平台第三方接口查询话务信息
    • 例如查询录制视频文件的URL等

AbstractgetCallId

  • getCallId(): undefined | string

    获取通话唯一标识

    Returns undefined | string

    通话唯一标识字符串

    Remarks

    用于唯一标识一次通话，可用于日志追踪、问题定位等场景

AbstractgetStatistics

  • getStatistics(): undefined | string

    获取统计信息

    Returns undefined | string

    以字符串形式返回的统计信息

    Remarks

    返回的字符串包含 "Config"、"Network"、"Transport" 和 "Participants" 4个节点， 分别表示音视频设置信息、网络状态信息、传输状态信息和参与者信息。

    统计信息包含以下主要部分：

    1. Config - 音视频设置信息

      • Audio Config - 音频设置，包括编解码、带宽、音频处理等参数
      • Video Config - 视频设置，包括编解码、分辨率、帧率、带宽等参数

    2. Network - 网络统计信息

      • Send Statistic - 数据发送统计，包括发包数、延迟、丢包率等
      • Recv Statistic - 数据接收统计，包括收包数、抖动、带宽估计等

    3. Transport - 传输通道信息

      • 本地和远端地址、通道质量、通道评分等

    4. Participants - 参与者信息

      • 每个参与者的音视频发送/接收统计
      • 订阅状态和质量指标

    示例：

    {
      "Config": {
        "Audio Config": {
          "SRTP": "off",
          "Codec": "opus",
          "Bitrate": 16000,
          // 更多音频配置...
        },
        "Video Config": {
          "Codec": "H264-SVC",
          "Resolution": "1280x720",
          "Framerate": 24,
          // 更多视频配置...
        }
      },
      "Network": {
        "Send Statistic": {
          "RTT": 4,
          "Lost": 2,
          "LostRate": 0,
          // 更多发送统计...
        },
        "Recv Statistic": {
          "Jitter": 1,
          "Lost": 0,
          // 更多接收统计...
        }
      },
      "Transport": {
        "Local": "2.1923737535:32414",
        "Path": "2 [udp]",
        // 更多传输信息...
      },
      "Participants": {
        "2333": {
          // 本地参与者统计...
        },
        "6666": {
          // 远端参与者统计...
        }
      }
    }

    此统计信息可用于监控和诊断通话质量问题，评估网络状况，以及优化音视频参数设置。

AbstractgetJsonStats

  • getJsonStats(): undefined | string

    获取实时统计信息

    Returns undefined | string

    以JSON字符串形式返回的实时统计信息

    Remarks

    返回的字符串包含多个关键性能指标，包括带宽估计、码率、延迟和丢包率等。

    示例：

    {
      "localActor": "[username:2333@100645.cloud.justalk.com]", // 用户标识
      "sendBWE": "1440",      // 发送带宽估计(kbps)
      "recvBWE": "929",       // 接收带宽估计(kbps)
      "sendBr": "16",         // 发送码率(kbps)
      "recvBr": "772",        // 接收码率(kbps)
      "sendJitter": "1",      // 发送抖动(ms)
      "recvJitter": "0",      // 接收抖动(ms)
      "sendLossRate": "0",    // 发送丢包率(%)
      "recvLossRate": "0",    // 接收丢包率(%)
      "encodeTime": "0",      // 编码时长(ms)
      "rtt":"5",              // 往返延时(ms)
      "audioSendBr": "19",    // 音频发送码率(kbps)
      "videoSendBr": "0",     // 视频发送码率(kbps)
      "audioLevel": "58",     // 音量级别(0-100)
      "event":""              // 事件信息
    }

AbstractgetSupportVideoSizes

  • getSupportVideoSizes(): ArrayList<JRTCVideoSize>

    获取当前通话支持的视频分辨率列表

    Returns ArrayList<JRTCVideoSize>

    支持的视频分辨率列表

    Remarks

    • 返回的列表中包含所有可用的视频分辨率选项
    • 可用于在通话过程中动态调整视频质量

AbstractsetUseExternalScreenCaptureControl

  • setUseExternalScreenCaptureControl(useExternalControl: boolean): any

    设置屏幕采集控制模式

    Parameters

    • useExternalControl: boolean

      是否使用外部控制模式

    Returns any

    Remarks

    控制屏幕采集的开启/关闭逻辑：

    • true: 由应用层通过 enableScreenCapture 接口控制
    • false: 由SDK根据通话业务自动控制（默认模式） SDK自动控制模式下的行为：
    • 通话建立且开启屏幕共享时，自动开启屏幕采集
    • 关闭屏幕共享或通话结束时，自动关闭屏幕采集

AbstractqueryAllGroups

  • queryAllGroups(): boolean

    查询所有业务号列表

    Returns boolean

    接口调用结果

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

    Remarks

    • 调用成功后，结果通过 onGetAllGroups 回调上报
    • 返回true仅表示接口调用成功，实际查询结果需要通过回调获取

Abstractcall

  • call(number: string, callParam?: JRTCCallCenterCallParam): boolean

    呼叫指定业务

    Parameters

    • number: string

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

    • OptionalcallParam: JRTCCallCenterCallParam

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

    Returns boolean

    接口调用结果

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

    Remarks

    • 通话状态会通过 onCallStateChanged 回调上报
    • 如果 callParam 为 undefined，将使用默认配置

AbstractcallAgent

  • callAgent(userId: string, callParam?: JRTCCallCenterCallParam): boolean

    呼叫指定座席（非直呼）

    Parameters

    • userId: string

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

    • OptionalcallParam: JRTCCallCenterCallParam

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

    Returns boolean

    接口调用结果

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

    Remarks

    • 通话状态会通过 onCallStateChanged 回调上报
    • 如果 callParam 为 undefined，将使用默认配置

AbstractoneToOneCall

  • oneToOneCall(userId: string, callParam?: JRTCCallCenterCallParam): boolean

    呼叫指定座席（直呼）

    Parameters

    • userId: string

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

    • OptionalcallParam: JRTCCallCenterCallParam

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

    Returns boolean

    接口调用结果

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

    Remarks

    • 通话状态会通过 onCallStateChanged 回调上报
    • 如果 callParam 为 undefined，将使用默认配置

    Deprecated

    该接口即将废弃，请使用 JRTCGuest.directCall 代替

AbstractdirectCall

  • directCall(userId: string, callParam?: JRTCCallCenterCallParam): boolean

    呼叫指定座席（直呼）

    Parameters

    • userId: string

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

    • OptionalcallParam: JRTCCallCenterCallParam

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

    Returns boolean

    接口调用结果

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

    Remarks

    • 通话状态会通过 onCallStateChanged 回调上报
    • 如果 callParam 为 undefined，将使用默认配置

Abstractanswer

  • answer(): boolean

    接听通话邀请

    Returns boolean

    接口调用结果

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

    Remarks

    • 仅在作为第三方访客同意接听通话邀请时调用
    • 其他情况不会用到此接口
    • 调用成功后会接收到 onCallStateChanged 回调

Abstractterm

  • term(): boolean

    结束通话

    Returns boolean

    接口调用结果

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

    Remarks

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

AbstractrequestUrgent

  • requestUrgent(): boolean

    请求加急

    Returns boolean

    接口调用结果

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

    Remarks

    加急请求处理流程：

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

AbstractresponseSignResult

  • responseSignResult(result: boolean, userId: string, extraInfo: string): boolean

    响应座席签名请求

    Parameters

    • result: boolean

      签名结果

    • userId: string

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

    • extraInfo: string

      随路额外消息

    Returns boolean

    接口调用结果

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

    Remarks

    签名流程：

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

AbstractturnCallType

  • turnCallType(callType: JRTCCallCenterCallType): any

    音视频通话类型切换

    Parameters

    Returns any

    Remarks

    支持的通话类型：

    • AUDIO: 语音通话

    • VIDEO: 视频通话

    • 可通过 getCallType 获取当前通话类型

    • 切换成功后，通话中所有成员会收到 onCallTypeChanged 或 JRTCAgentCallback.onCallTypeChanged onCallTypeChanged 回调

AbstractsendMessage

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

    发送消息

    Parameters

    • contentType: string

      消息内容类型

    • content: string

      消息内容

    • toUserId: string

      接收消息的用户ID，undefined表示发送给所有成员

    Returns boolean

    接口调用是否成功

    Remarks

    • 消息内容不能大于4K
    • 指定成员会收到 onMessageReceived 或 JRTCAgentCallback.onMessageReceived onMessageReceived 回调
    • 如果toUserId为undefined，则给通话中全部成员发送消息

AbstractsendNotifyMessage

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

    发送事件通知消息

    Parameters

    • notifyMessage: JRTCNotifyMessage

      事件通知实体对象

    • toUserId: string

      接收消息的用户ID，undefined表示发送给所有成员

    Returns boolean

    接口调用是否成功

    Remarks

    • 通话中的其他成员会收到 onNotifyMessageReceived 或 JRTCAgentCallback.onNotifyMessageReceived onNotifyMessageReceived 回调
    • 如果toUserId为undefined，则给通话中全部成员发送通知消息

AbstractenableUploadAudioStream

  • enableUploadAudioStream(enable: boolean): boolean

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

    Parameters

    • enable: boolean

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

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

    Returns boolean

    接口调用结果

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

    Remarks

    • 调用该方法可开启或关闭发送本地音频流。开启后，通话成员将听见本端声音；关闭后，通话将听不见本端声音
    • 通话中调用此方法不影响接收远端音频
    • 初始化JRTCAgent时，默认不发送本地音频流。若要进入通话时，让通话内其他成员听见本端声音，建议在进入通话前设置
    • 该方法在通话内和通话外均可调用，离开通话后会重置。
    • 通话中也可调用此方法开启或关闭发送本地音频流，服务器会更新状态并同步给其他房间成员，即通话中所有成员都会收到 onMemberUpdate 或 JRTCAgentCallback.onMemberUpdate onMemberUpdate 回调
    • 在调用此方法时，用户不在通话中，不会收到回调
    • 在调用此方法时，用户在通话中，会收到 onCallPropertyChanged 回调

AbstractenableUploadVideoStream

  • enableUploadVideoStream(enable: boolean): boolean

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

    Parameters

    • enable: boolean

      是否发送本地视频流

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

    Returns boolean

    接口调用结果

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

    Remarks

    • 调用该方法可开启或关闭发送本地视频流。开启后，通话成员将可以看见本端视频画面；关闭后，通话成员将看不见本端视频画面
    • 通话中调用此方法不影响接收远端视频
    • 初始化JRTCAgent时，默认发送本地视频流。若要进入通话时，让通话内其他成员看见本端视频画面，建议在进入通话前设置
    • 该方法在通话内和通话外均可调用，离开通话后会重置。
    • 通话中也可调用此方法开启或关闭发送本地视频流，服务器会更新状态并同步给其他通话成员，即通话中所有成员都会收到 onMemberUpdate 或 JRTCAgentCallback.onMemberUpdate onMemberUpdate 回调
    • 在调用此方法时，用户不在通话中，不会收到回调
    • 在调用此方法时，用户在通话中，会收到 onCallPropertyChanged 回调

AbstractgetUploadLocalAudio

  • getUploadLocalAudio(): boolean

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

    Returns boolean

    是否上传音频数据

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

AbstractgetUploadLocalVideo

  • getUploadLocalVideo(): boolean

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

    Returns boolean

    是否在上传本地视频数据

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

AbstractsendAudioEmptyPack

  • sendAudioEmptyPack(empty: boolean): boolean

    发送音频空包

    Parameters

    • empty: boolean

      音频发送包是否为空包

      • true: 发送音频空包
      • false: 发送正常音频包

    Returns boolean

    接口调用结果

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

    Remarks

    该接口不会导致成员的 audio 属性变化， 发送音频空包不代表停止发送音频流。可用于临时屏蔽音频内容但保持音频流连接。

AbstractsendVideoEmptyPack

  • sendVideoEmptyPack(empty: boolean): boolean

    发送视频空包

    Parameters

    • empty: boolean

      视频发送包是否为空包

      • true: 发送视频空包
      • false: 发送正常视频包

    Returns boolean

    接口调用结果

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

    Remarks

    该接口不会导致成员的 video 属性变化， 发送视频空包不代表停止发送视频流。可用于临时屏蔽视频内容但保持视频流连接。

AbstractenableScreenShare

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

    开启/关闭屏幕共享

    Parameters

    • enable: boolean

      开启或关闭屏幕共享

      • true: 开启屏幕共享
      • false: 关闭屏幕共享
    • OptionalsendScreenParam: JRTCSendScreenParam

      屏幕共享媒体参数

    • OptionalenableAudio: boolean

      是否采集系统音频

      • true: 采集系统音频
      • false: 不采集系统音频

    Returns boolean

    接口调用结果

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

    Remarks

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

AbstractsuspendScreenShare

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

    暂停/继续屏幕共享

    Parameters

    • suspend: boolean

      是否暂停屏幕共享

      • true: 暂停屏幕共享
      • false: 继续屏幕共享
    • tip: string

      暂停屏幕共享后显示的提示文字

    Returns boolean

    接口调用结果

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

    Remarks

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

AbstractisSuspendScreenShare

  • isSuspendScreenShare(): boolean

    获取屏幕共享是否处于暂停状态

    Returns boolean

    屏幕共享暂停状态

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

AbstractgetShareStreamId

  • getShareStreamId(): undefined | string

    获取屏幕共享的视频流ID

    Returns undefined | string

    屏幕共享的视频流ID

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

    Remarks

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

AbstractgetShareUserId

  • getShareUserId(): undefined | string

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

    Returns undefined | string

    发起屏幕共享者的用户ID

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

    Remarks

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

AbstractsetRatio

  • setRatio(ratio: number): boolean

    设置本端视频宽高比

    Parameters

    • ratio: number

      视频宽高比

    Returns boolean

    接口调用是否成功

    Remarks

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

AbstractgetRequestSize

  • getRequestSize(): JRTCVideoSize

    获取视频请求尺寸

    Returns JRTCVideoSize

    视频请求尺寸

    Remarks

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

AbstractsetRequestSize

  • setRequestSize(requestSize: JRTCVideoSize): any

    设置视频请求尺寸

    Parameters

    Returns any

    Remarks

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

AbstractrequestVideo

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

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

    Parameters

    • participant: JRTCRoomParticipant

      需要订阅视频的成员对象

      • 特定成员：传入 JRTCRoomParticipant 对象以订阅指定成员的视频
      • undefined：表示不订阅任何成员的视频
    • videoSize: JRTCVideoSize

      视频请求的尺寸

      • 特定尺寸：传入 JRTCVideoSize 对象以请求特定分辨率
      • undefined：使用默认尺寸

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于订阅指定成员的视频流，成功订阅后可以接收并显示该成员的视频画面。

    通常需要在订阅成功后，调用媒体设备的相关方法来渲染视频画面。

AbstractunRequestVideo

  • unRequestVideo(participant: JRTCRoomParticipant): boolean

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

    Parameters

    • participant: JRTCRoomParticipant

      需要取消订阅视频的成员对象

      • 特定成员：传入 JRTCRoomParticipant 对象以取消订阅指定成员的视频
      • undefined：表示取消当前所有的视频订阅

    Returns boolean

    操作结果

    • true: 接口调用成功，会收到 JRTCAgentCallback.onMemberUpdate onMemberUpdate 回调
    • false: 接口调用失败

    Remarks

    此方法用于取消订阅指定成员的视频流，取消订阅后将不再接收该成员的视频数据，可节省带宽和性能资源。

    成功调用后会收到参与者更新回调，可关注 videoSize 属性的变化。

AbstractrequestScreenVideo

  • requestScreenVideo(videoSize: JRTCVideoSize): boolean

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

    Parameters

    • videoSize: JRTCVideoSize

      视频请求的尺寸

      • 特定尺寸：传入 JRTCVideoSize 对象以请求特定分辨率
      • undefined：使用默认尺寸

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于订阅通话中的屏幕共享视频流。成功订阅后，可以接收并显示屏幕共享的内容。

    订阅后，可以通过 getShareStreamId 获取屏幕共享的视频流ID，并用于渲染显示。

AbstractunRequestScreenVideo

  • unRequestScreenVideo(): boolean

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

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于取消订阅通话中的屏幕共享视频流。取消订阅后，将不再接收屏幕共享的视频数据， 可以节省带宽和处理资源。

AbstractcreateExtraStream

  • createExtraStream(
        captureStreamId: string,
        screenShare: boolean,
    ): undefined | string

    创建额外视频流

    Parameters

    • captureStreamId: string

      本地视频流采集源流Id

    • screenShare: boolean

      是否屏幕共享（包括窗口共享、区域共享）

    Returns undefined | string

    通话中的视频流ID 创建成功后，通话内其他成员将收到 onMemberUpdate 回调

AbstractdeleteExtraStream

  • deleteExtraStream(captureStreamId: string): boolean

    删除额外视频流

    Parameters

    • captureStreamId: string

      本次视频流采集源流Id

    Returns boolean

    接口调用结果

    • true: 接口调用成功，通话内其他成员将收到 onMemberUpdate 回调
    • false: 接口调用异常

AbstractrequestExtraStreamVideo

  • requestExtraStreamVideo(
        participant: JRTCRoomParticipant,
        streamId: string,
        videoSize: JRTCVideoSize,
    ): boolean

    订阅通话中其他用户的额外视频流

    Parameters

    Returns boolean

    接口调用结果

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

AbstractunRequestExtraStreamVideo

  • unRequestExtraStreamVideo(
        participant: JRTCRoomParticipant,
        streamId: string,
    ): boolean

    取消订阅通话中其他用户的额外视频流

    Parameters

    Returns boolean

    接口调用结果

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

AbstractenableLocalRecord

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

    开启/关闭本地录制

    Parameters

    • enable: boolean

      是否开启本地录制

      • true: 开启本地录制功能
      • false: 关闭本地录制功能
    • recordParam: JRTCRecordLocalParam

      本地录制参数配置

      • 开启录制时(enable=true)：filePath 必须设置，其余参数不设置则使用默认配置
      • 关闭录制时(enable=false)：可传入 undefined

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于控制本地录制功能的开启和关闭。录制的文件将保存在指定的路径中。

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

AbstractupdateLocalRecordLayout

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

    更新本地录制自定义布局

    Parameters

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于动态更新本地录制时的视频布局，可以在录制过程中多次调用来改变布局效果。

    自定义布局可以调整各个参与者视频画面的位置、大小和层级关系，适用于需要特定布局效果的场景。

AbstractisLocalRecording

  • isLocalRecording(): boolean

    是否正在本地录制

    Returns boolean

    本地录制状态

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

    Remarks

    此方法用于检查当前是否正在进行本地录制。可以在需要了解录制状态的场景下使用， 例如更新UI状态或决定是否执行特定操作。

AbstractenableRemoteRecord

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

    开启/关闭远程视频录制

    Parameters

    • enable: boolean

      是否开启远程视频录制

      • true: 开启远程视频录制
      • false: 关闭远程视频录制
    • recordParam: undefined | JRTCRecordRemoteParam

      远程录制参数配置

      • 开启录制时(enable=true)：可传入特定参数或 undefined 使用默认配置
      • 关闭录制时(enable=false)：可传入 undefined

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于控制远程服务器的视频录制功能。开启后，服务器将录制通话内容。

    录制状态变化会通过 onCallPropertyChanged 回调通知， 可关注 remoteRecordState 属性。

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

AbstractupdateRemoteRecordLayout

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

    更新远程录制自定义布局

    Parameters

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于动态更新远程录制时的视频布局，可以在录制过程中多次调用来改变布局效果。

    自定义布局可以调整各个参与者视频画面在录制中的位置、大小和层级关系。

AbstractupdateRemoteRecordWatermark

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

    更新远程录制水印信息

    Parameters

    • watermarkTextMap: HashMap<string, string>

      水印文本信息映射表

      • 具体水印映射：传入键值对形式的水印文本信息
      • undefined：移除所有水印

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于在远程录制的视频上添加或更新文字水印。

    水印可以用于标识录制内容的来源、时间、版权等信息，提高录制内容的专业性和安全性。

AbstractgetRemoteRecordState

  • getRemoteRecordState(): JRTCRemoteRecordState

    获取远程视频录制状态

    Returns JRTCRemoteRecordState

    当前远程录制状态

    • NONE：无法进行视频录制。用户不在通话中或加入通话时未设置录制参数
    • READY：可以开启视频录制。用户在加入通话时设置了录制参数，但未开始录制
    • RUNNING：正在录制中。用户在加入通话时设置了录制参数，且当前正在录制

    Remarks

    此方法用于查询当前远程录制的状态，可以据此更新UI界面或执行相关操作。

    远程录制状态变化会通过 onCallPropertyChanged 回调通知。

AbstractsetVideoDot

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

    远程录制视频打点

    Parameters

    • timespan: string

      时间戳，用于标识打点位置

    • info: string

      打点信息，可包含任意文本描述

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于在录制的视频中添加标记点，方便后续查看时快速定位到重要时刻。

    打点信息将与时间戳一起保存，可用于描述该时刻发生的重要事件或内容变化。

AbstractenableMicAgc

  • enableMicAgc(enable: boolean): boolean

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

    Parameters

    • enable: boolean

      是否开启麦克风增益

      • true: 开启麦克风增益
      • false: 关闭麦克风增益

    Returns boolean

    接口调用结果

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

    Remarks

    • 默认情况下，麦克风增益功能是开启的
    • 需要在加入房间后调用此方法才能生效
    • 麦克风增益可以提高声音的音量，使声音更加清晰

AbstractsetSubScreenShare

  • setSubScreenShare(enable: boolean): boolean

    设置是否订阅屏幕共享

    Parameters

    • enable: boolean

      是否订阅屏幕共享

      • true: 自动订阅通话中的屏幕共享内容
      • false: 不自动订阅屏幕共享内容

    Returns boolean

    操作结果

    • true: 接口调用成功
    • false: 接口调用失败

    Remarks

    此方法用于控制是否自动订阅通话中的屏幕共享内容。设置为自动订阅后， 当通话中有成员开始共享屏幕时，将自动接收屏幕共享视频流。

    这个设置适用于需要自动显示屏幕共享内容的场景，避免手动调用订阅方法。

AbstractisSubScreenShare

  • isSubScreenShare(): boolean

    获取是否订阅屏幕共享

    Returns boolean

    屏幕共享订阅状态

    • true: 当前设置为自动订阅屏幕共享
    • false: 当前设置为不自动订阅屏幕共享

    Remarks

    此方法用于查询当前是否设置了自动订阅屏幕共享。可以根据此状态 决定是否需要调用 setSubScreenShare 方法改变设置。

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

设置

主题