Class JRTCRoomAbstract

Static ReadonlyTAG

Static ReadonlyDM

Staticcreate

• create(
      client: undefined | JRTCClient,
      mediaDevice: undefined | JRTCMediaDevice,
      callback: undefined | JRTCRoomCallback,
  ): undefined | JRTCRoom

  创建房间管理对象

  Parameters

  • client: undefined | JRTCClient

    JRTCClient对象，用于提供基础通信功能
  • mediaDevice: undefined | JRTCMediaDevice

    JRTCMediaDevice对象，用于提供媒体设备管理功能
  • callback: undefined | JRTCRoomCallback

    JRTCRoomCallback对象，用于接收房间相关事件回调

  Returns undefined | JRTCRoom

  创建的JRTCRoom对象，如果参数无效则返回undefined

  Remarks

  创建房间管理对象前，需要确保JRTCClient已经初始化成功

Staticdestroy

• destroy(): void

  销毁JRTCRoom对象

  Returns void

  Remarks

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

AbstractgetRoomId

• getRoomId(): undefined | string

  获取房间号

  Returns undefined | string

  当前房间的房间号，未加入房间时可能为 undefined

AbstractgetSerialId

• getSerialId(): undefined | string

  获取业务流水号

  Returns undefined | string

  业务流水号，未设置时可能为 undefined

AbstractgetCallId

• getCallId(): undefined | string

  获取房间唯一标识

  Returns undefined | string

  通话唯一标识字符串

  Remarks

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

AbstractgetTitle

• getTitle(): undefined | string

  获取房间标题

  Returns undefined | string

  房间标题，未设置时可能为 undefined

AbstractgetState

• getState(): JRTCRoomState

  获取自己当前在房间中的状态

  Returns JRTCRoomState

  当前在房间中的状态

  Remarks

  可能的状态值包括：

  • IDLE - 空闲状态
  • JOINING - 加入中
  • JOINED - 已加入
  • LEAVING - 离开中

AbstractgetParticipants

• getParticipants(): any

  获取房间中的所有成员

  Returns any

  房间成员列表，未加入房间时可能为 undefined

AbstractgetUploadLocalAudio

• getUploadLocalAudio(): boolean

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

  Returns boolean

  是否上传音频数据

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

AbstractgetUploadLocalVideo

• getUploadLocalVideo(): boolean

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

  Returns boolean

  是否在上传本地视频数据

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

AbstractgetAudioOutput

• getAudioOutput(): boolean

  获取音频是否输出

  Returns boolean

  是否音频输出

  • true: 输出中
  • false: 未输出

  Remarks

  本地没有音频输出的话，将听不到房间内其他成员的声音

AbstractgetShareStreamId

• getShareStreamId(): string

  获取屏幕共享的视频流ID

  Returns string

  屏幕共享的视频流ID

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

  Remarks

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

AbstractgetShareUserId

• getShareUserId(): string

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

  Returns string

  发起屏幕共享者的用户ID

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

  Remarks

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

AbstractisLocalRecording

• isLocalRecording(): boolean

  是否正在本地录制

  Returns boolean

  本地录制状态

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

  Remarks

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

AbstractgetRemoteRecordState

• getRemoteRecordState(): JRTCRemoteRecordState

  获取远程视频录制状态

  Returns JRTCRemoteRecordState

  当前远程录制状态

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

  Remarks

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

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

AbstractgetCDNState

• getCDNState(): JRTCCDNState

  获取CDN推流状态

  Returns JRTCCDNState

  CDN推流状态

  Remarks

  可能的状态值包括：

  • JRTCCDNState.NONE - 无法进行CDN推流（用户不在房间中或加入房间时没有设置CDN推流参数）
  • JRTCCDNState.READY - 可以开启CDN推流（用户在加入房间时设置了CDN推流参数，但未开始推流）
  • JRTCCDNState.RUNNING - CDN推流中（用户在加入房间时设置了CDN推流参数，并且正在推流中）

AbstractsetUseExternalScreenCaptureControl

• setUseExternalScreenCaptureControl(useExternalControl: boolean): void

  设置是否由应用层自行控制屏幕采集逻辑

  Parameters

  • useExternalControl: boolean

    是否由应用层自行控制屏幕采集逻辑

    • true: 由应用层自行调用 JRTCMediaDevice.enableScreenCapture 接口控制屏幕采集开启/关闭逻辑
    • false: 由SDK内部根据通话业务开始/结束自动控制屏幕采集开启/关闭逻辑

  Returns void

  Remarks

  默认为false，由SDK内部根据通话业务开始/结束自动控制屏幕采集开启/关闭逻辑， 比如加入房间时开启屏幕共享自动开启屏幕采集，关闭屏幕共享或者离开房间时自动关闭屏幕采集

AbstractsetNotifyVolumeChange

• setNotifyVolumeChange(b: boolean): void

  设置是否上报音量变化

  Parameters

  • b: boolean

    是否上报音量变化

  Returns void

  Remarks

  音量变化会比较频繁，默认为true，不需要则设置为false

AbstractisNotifyVolumeChange

• isNotifyVolumeChange(): boolean

  获取是否上报音量变化

  Returns boolean

  是否上报音量变化

AbstractgetSupportVideoSizes

• getSupportVideoSizes(): ArrayList<JRTCVideoSize>

  获取房间支持的视频分辨率列表

  Returns ArrayList<JRTCVideoSize>

  房间视频分辨率列表

Abstractquery

• query(roomId: string): number

  查询房间相关信息

  Parameters

  • roomId: string

    房间标识

  Returns number

  操作ID，与 JRTCRoomCallback.onQuery 回调中的operationId对应

  Remarks

  调用此接口可以查询房间相关信息，例如房间是否存在，房间人数等， 结果通过 JRTCRoomCallback.onQuery 回调通知

Abstractjoin

• join(roomId: string, joinParam: JRTCRoomJoinParam): boolean

  加入房间

  Parameters

  • roomId: string

    房间标识
  • joinParam: JRTCRoomJoinParam

    JRTCRoomJoinParam对象，传undefined则使用默认配置

  Returns boolean

  接口调用结果

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

  Remarks

  该方法让用户加入通话房间，在同一个房间内的用户可以互相通话。 如果用户已在房间中，必须退出当前房间，即处于空闲状态，才能进入其他房间， 否则将直接返回false，且不会收到回调通知。

  See

  JRTCRoomJoinParam

Abstractleave

• leave(): boolean

  离开房间

  Returns boolean

  接口调用结果

  • true: 接口调用成功，非空闲状态下，会收到 JRTCRoomCallback.onLeave 回调
  • false: 接口调用异常

AbstractkickUser

• kickUser(userId: string): boolean

  把成员踢出房间

  Parameters

  • userId: string

    成员用户ID

  Returns boolean

  接口调用结果

  • true: 接口调用成功，非空闲状态下，会收到 JRTCRoomCallback.onKickUserResult 回调
  • false: 接口调用异常

AbstractenableUploadAudioStream

• enableUploadAudioStream(enable: boolean): boolean

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

  Parameters

  • enable: boolean

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

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

  Returns boolean

  接口调用结果

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

  Remarks

  • 调用该方法可开启或关闭发送本地音频流。开启后，房间成员将听见本端声音；关闭后，房间成员将听不见本端声音
  • 房间中调用此方法不影响接收远端音频
  • 初始化JRTCRoom时，默认不发送本地音频流。若要加入房间时，让房间内其他成员听见本端声音，需要在调用 join 加入房间前设置
  • 该方法在房间内和房间外均可调用，且在离开房间后该设置仍然有效。也就是说这一次设置了开启发送本地音频流，那么在下一次加入房间时默认会开启发送本地音频流
  • 通话中也可调用此方法开启或关闭发送本地音频流，服务器会更新状态并同步给其他房间成员，即房间中所有成员都会收到 onParticipantUpdate 回调
  • 在调用此方法时，用户未加入房间，不会收到回调
  • 在调用此方法时，用户已在房间中，会收到 onRoomPropertyChanged 回调

AbstractenableUploadVideoStream

• enableUploadVideoStream(enable: boolean): boolean

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

  Parameters

  • enable: boolean

    是否发送本地视频流

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

  Returns boolean

  接口调用结果

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

  Remarks

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

AbstractenableAudioOutput

• enableAudioOutput(enable: boolean): boolean

  开启/关闭音频输出

  Parameters

  • enable: boolean

    是否开启音频输出

    • true: 开启音频输出
    • false: 关闭音频输出

  Returns boolean

  接口调用结果

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

  Remarks

  • 该方法可实现本地静音功能。关闭时听不到房间内其他成员的声音，不影响其他成员；开启时可以听到其他成员声音
  • 初始化JRTCRoom时，音频输出功能默认是开启的。若要加入房间时听不见其他成员的声音，建议在调用 join 加入房间前设置

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: 接口调用成功，会收到 onParticipantUpdate 回调
  • 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 创建成功后，通话内其他成员将收到 JRTCRoomCallback#onParticipantUpdate 回调

AbstractdeleteExtraStream

• deleteExtraStream(captureStreamId: string): boolean

  删除额外视频流

  Parameters

  • captureStreamId: string

    本次视频流采集源流Id

  Returns boolean

  接口调用结果

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

AbstractrequestExtraStreamVideo

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

  订阅房间中其他用户的额外视频流

  Parameters

  • participant: JRTCRoomParticipant

    JRTCRoomParticipant 成员对象
  • streamId: string

    视频流ID
  • videoSize: JRTCVideoSize

    视频请求的尺寸

  Returns boolean

  接口调用结果

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

AbstractunRequestExtraStreamVideo

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

  取消订阅房间中其他用户的额外视频流

  Parameters

  • participant: JRTCRoomParticipant

    JRTCRoomParticipant 成员对象
  • streamId: string

    视频流ID

  Returns boolean

  接口调用结果

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

AbstractenableLocalRecord

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

  开启/关闭本地录制

  Parameters

  • enable: boolean

    是否开启本地录制

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

    本地录制参数配置

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

  Returns boolean

  操作结果

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

  Remarks

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

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

AbstractupdateLocalRecordLayout

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

  更新本地录制自定义布局

  Parameters

  • layoutList: ArrayList<JRTCRecordLocalLayout>

    需要更新的布局列表

    • 具体布局列表：传入 JRTCRecordLocalLayout 对象列表以设置自定义布局
    • undefined：使用默认布局

  Returns boolean

  操作结果

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

  Remarks

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

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

AbstractenableCdn

• enableCdn(enable: boolean, keyInterval: number): boolean

  开启/关闭CDN推流

  Parameters

  • enable: boolean

    开启/关闭CDN推流

    • true: 开启CDN推流
    • false: 关闭CDN推流
  • keyInterval: number

    推流关键帧间隔(毫秒)

    • 当参数 enable 为 true 时有效
    • 有效值需要 >= 1000

  Returns boolean

  接口调用结果

  • true: 接口调用成功，会收到 JRTCRoomCallback.onRoomPropertyChanged 通知
  • false: 接口调用异常

  Remarks

  CDN推流功能需要在加入房间时通过 JRTCRoomJoinParam 设置相关参数， 否则无法开启CDN推流。

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

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

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

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

AbstractupdateRemoteRecordLayout

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

  更新远程录制自定义布局

  Parameters

  • layoutList: ArrayList<JRTCRecordRemoteLayout>

    需要更新的布局列表

    • 具体布局列表：传入 JRTCRecordRemoteLayout 对象列表以设置自定义布局
    • undefined：使用默认布局

  Returns boolean

  操作结果

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

  Remarks

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

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

AbstractupdateRemoteRecordWatermark

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

  更新远程录制水印信息

  Parameters

  • watermarkTextMap: HashMap<string, undefined | string>

    水印文本信息映射表

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

  Returns boolean

  操作结果

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

  Remarks

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

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

AbstractenableRemoteAdvancedRecord

• enableRemoteAdvancedRecord(): boolean

  开启通用化远程录制

  Returns boolean

  接口调用结果

  • true: 接口调用成功，开启结果通过 JRTCRoomCallback.onEnableRemoteAdvancedRecordResult 回调
  • false: 接口调用异常

  Remarks

  • 该录制服务是在基础录制服务的基础上，支持多路混流录制和分流录制同时输出的功能
  • 输出文件格式包括：视频 mp4、avi；音频：wav、aac、mp3
  • 后续会开放更改录制配置文件，目前使用默认配置文件
  • 使用该接口开启远程录制，目前没有关闭录制接口，所有人离开房间后会自动结束录制
  • 使用该接口也不需要判断录制状态是否可开启

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: 屏幕共享未暂停

AbstractgetParticipant

• getParticipant(userId: string): undefined | JRTCRoomParticipant

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

  Parameters

  • userId: string

    用户唯一标识

  Returns undefined | JRTCRoomParticipant

  房间成员对象

  • 房间内有此用户标识的用户: JRTCRoomParticipant 对象
  • 房间内无此用户标识的用户: undefined

AbstractgetStatistics

• getStatistics(): string

  获取统计信息

  Returns 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": {
        // 远端参与者统计...
      }
    }
  }
  Copy

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

AbstractgetJsonStats

• getJsonStats(): string

  获取实时统计信息

  Returns 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":""              // 事件信息
  }
  Copy

AbstractsetCustomProperty

• setCustomProperty(key: string, value: undefined | string): boolean

  设置房间自定义属性

  Parameters

  • key: string

    自定义属性的键名
  • value: undefined | string

    自定义属性的值，传入 undefined 表示删除该属性

  Returns boolean

  接口调用结果

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

  Remarks

  房间自定义属性可用于在房间内存储和共享一些应用层的信息， 如房间主题、会议议程等。设置成功后，房间内所有成员都可以通过 getCustomProperty 方法获取到该属性。

AbstractgetCustomProperty

• getCustomProperty(key: string): string

  获取房间自定义属性

  Parameters

  • key: string

    自定义属性的键名

  Returns string

  属性值，如果属性不存在则返回空字符串

  Remarks

  调用此接口来获取通过 setCustomProperty 设置的自定义房间属性。

AbstractsendMessage

• sendMessage(
      type: string,
      content: string,
      toUserId: undefined | string,
  ): boolean

  发送房间消息

  Parameters

  • type: string

    消息类型，用于区分不同种类的消息
  • content: string

    消息内容，不能大于4KB
  • toUserId: undefined | string

    指定接收消息的成员用户ID

    • 传入特定用户ID: 仅向该用户发送消息
    • 传入 undefined: 向房间内所有成员发送消息

  Returns boolean

  接口调用结果

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

  Remarks

  消息接收方都会收到 onMessageReceived 回调。 消息内容大小限制为4KB，超过限制将发送失败。

AbstractinviteSipUser

• inviteSipUser(sipParam: JRTCSipInviteParam): number

  邀请SIP用户加入房间

  Parameters

  • sipParam: JRTCSipInviteParam

    邀请SIP用户入会的配置参数，详见 JRTCSipInviteParam

  Returns number

  操作ID或错误码

  • > 0: 操作ID，结果通过 onInviteSipUserResult 回调通知
  • -1: 调用失败，不会收到回调通知

  Remarks

  此功能通常用于对接落地网关等SIP设备，使其能够加入到当前通话中。

AbstractsetRatio

• setRatio(ratio: number): boolean

  设置本端视频宽高比

  Parameters

  • ratio: number

    视频宽高比，例如16:9为1.778，4:3为1.333

  Returns boolean

  接口调用结果

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

  Remarks

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

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 属性变化， 发送视频空包不代表停止发送视频流。可用于临时屏蔽视频内容但保持视频流连接。

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: 未订阅屏幕共享

AbstractgetRoomHandle

• getRoomHandle(): number

  获取房间句柄

  Returns number

  房间句柄，用于底层通信

  Remarks

  房间句柄是SDK内部用于标识和操作特定房间的唯一标识符。 通常仅在需要与底层API交互时使用。