Class JRTCCallAbstract

Remarks

该方法用于创建JRTCCall实例。JRTCCall是单例模式，重复调用该方法会返回同一个对象， 除非之前调用过destroy方法销毁了对象。

使用注意事项：

• 所有接口函数，如无特殊说明，都建议在主线程调用
• 请确保在调用其他API前先调用该方法创建并初始化对象
• 调用此方法前确保JRTCClient已完成初始化，即state属性值不等于NOT_INIT

Remarks

该方法用于释放JRTCCall实例占用的资源。这是一个同步调用方法，会等待资源释放完成后才返回。

使用注意事项：

• 调用此方法后，无法再使用JRTCCall的其它方法和回调
• 不建议在JRTCSDK的回调中调用此方法，否则可能导致崩溃
• 如需在销毁后再次创建JRTCCall实例，需要等待本方法执行结束后再创建

Remarks

此方法用于设置用户在通话中的角色。

注意：该接口只有在接受邀请前设置有效，如果是主动加入通话， 请使用加入通话参数（JRTCCallJoinParam）设置角色。

Remarks

此方法用于加入一个通话，加入后可与通话内的其他用户进行音视频交流。

该接口还支持在加入通话的同时邀请其他用户，通过设置 JRTCCallJoinParam 中的 inviteCalleeUserId 和 inviteCalleeUserType 参数实现。

使用注意事项：

• 调用前需确保用户已登录
• 如果用户已在其他通话中，必须先退出当前通话才能加入新通话
• 若已在通话中直接调用此方法，将返回false且不会收到回调通知

Remarks

此方法用于离开当前通话，仅自己离开，不影响其他通话成员。 调用此方法前需确保用户已经加入了通话。

Remarks

此方法用于结束整个通话，自己会离开通话，并踢出通话中的所有其他成员。 调用此方法前需确保用户已经加入了通话。

Remarks

此方法用于邀请其他用户加入当前通话。 调用此方法前需确保用户已经加入了通话。

被邀请方会收到通话邀请，可以选择接受或拒绝。邀请结果将通过 onInviteResult 回调通知。

Remarks

此方法用于取消之前发出的通话邀请。被邀请方将不再收到通话邀请，或者收到邀请被取消的通知。 取消邀请的结果将通过回调通知。

Remarks

此方法用于接受收到的通话邀请。接受邀请后，将会加入到通话中。 接受邀请的结果将通过回调通知。

Remarks

此方法用于拒绝收到的通话邀请。拒绝后，邀请方将收到拒绝通知。 拒绝邀请的结果将通过回调通知。

Remarks

此方法用于获取当前用户在通话中的参与者对象，可用于获取自己的音视频状态等信息。

Remarks

此方法用于获取通话中的所有参与者，包括自己和其他成员。 可用于显示参与者列表或进行群组操作。

Remarks

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

Remarks

此方法用于获取当前用户在通话中的状态，可用于判断是否已加入通话或正在进行状态转换。

Remarks

业务流水号是标识此次通话业务操作的唯一号码，通常用于关联特定业务场景或进行日志追踪。

Remarks

通话ID是由服务器分配的唯一标识符，用于唯一标识一个通话实例。 可用于日志记录、问题排查或与其他系统集成时的关联标识。

Remarks

可用于检查当前是否正在向其他通话成员传输本地音频。

Remarks

可用于检查当前是否正在向其他通话成员传输本地视频流。

Remarks

本地没有音频输出时，将听不到通话内其他成员的声音。 此方法可用于检查当前的音频输出状态。

Remarks

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

Remarks

可用来判断当前通话中是否有成员发起屏幕共享，以及确定是哪个用户在共享屏幕。

Remarks

返回的字符串包含四个主要节点："Config"、"Network"、"Transport"和"Participants"，分别对应音视频设置信息、 网络统计信息、传输通道信息和通话参与者信息。

此方法可用于分析通话质量和进行问题排查，包含丰富的媒体和网络参数指标。

统计信息格式示例：

{
  "Config": {
    "Audio Config": {
      "SRTP": "off",
      "Codec": "opus",
      ...
    },
    "Video Config": {
      "SRTP": "off",
      "Codec": "H264-SVC",
      ...
    }
  },
  "Network": {
    "Send Statistic": {
      "Packets": "181|1305|0|0",
      "RTT": "4",
      ...
    },
    "Recv Statistic": {
      ...
    }
  },
  "Transport": {
    ...
  },
  "Participants": {
    ...
  }
}
Copy

Remarks

此方法提供了比 getStatistics 更为简洁的统计信息，适合需要监控通话实时状态的场景。 返回的数据包括带宽估计、码率、延迟、丢包率等核心指标。

统计信息格式示例：

{
  "localActor": "[username:2333@100645.cloud.justalk.com]",
  "sendBWE": "1440",
  "recvBWE": "929",
  "sendBr": "16",
  "recvBr": "772",
  "sendJitter": "1",
  "recvJitter": "0",
  "sendLossRate": "0",
  "recvLossRate": "0",
  "encodeTime": "0",
  "rtt": "5",
  "audioSendBr": "19",
  "videoSendBr": "0",
  "audioLevel": "58",
  "event": ""
}
Copy

Remarks

用于获取当前通话环境支持的所有视频分辨率选项。 开发者可以根据返回的分辨率列表，在视频通话或会议中选择合适的分辨率设置。

Remarks

指定接收者会收到 onMessageReceived 回调。 此方法可用于在通话中实现文本聊天、命令传递等功能。

Remarks

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

Remarks

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

Remarks

该方法可实现本地静音功能。关闭音频输出时，听不到通话内其他成员的声音，但不影响其他成员； 开启音频输出时，可以听到其他成员声音。

初始化JRTCCall时，音频输出功能默认是开启的。如需在加入通话时就不听见其他成员的声音， 建议在调用 join 加入通话前设置。

Remarks

该接口不会导致成员的 JRTCRoomParticipant.audio 属性变化，发送音频空包 不代表停止发送音频流。此方法通常用于座席保持通话等特殊场景。

发送空包时，其他成员将收不到本端的实际音频内容，但通话连接依然保持。

Remarks

该接口不会导致成员的 JRTCRoomParticipant.video 属性变化，发送视频空包 不代表停止发送视频流。此方法通常用于座席保持通话等特殊场景。

发送空包时，其他成员将收不到本端的实际视频内容，但通话连接依然保持。

Remarks

此方法只负责信令通知，请确保开启屏幕共享前已经开启了屏幕采集， 否则远端用户收到屏幕共享画面为黑屏。

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

Remarks

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

调用成功后可通过 isSuspendScreenShare 方法 判断当前屏幕共享是否处于暂停状态。

Remarks

此方法用于检查当前屏幕共享是否处于暂停状态。 通常与 suspendScreenShare 方法配合使用，用于控制和获取屏幕共享的状态。

Remarks

此方法将自己的视频采集根据指定宽高比裁剪后进行发送，通话中其他成员收到的画面将是裁剪后的比例。

此方法不影响其他成员的画面在本端的显示比例，也不影响其他成员相互之间的画面显示比例。

注意：必须在开始通话后设置才能生效。

Remarks

此方法用于获取当前设置的视频请求尺寸。视频请求尺寸会影响自己看其他成员的视频分辨率， 通常用于控制接收视频的质量和流量消耗。

Remarks

此方法用于设置接收其他成员视频时的请求尺寸，影响视频清晰度和带宽占用。 在渲染画面前设置才有效，建议在通话开始前设置。

较大的请求尺寸会提供更清晰的视频画面，但也会消耗更多带宽和处理资源。

Remarks

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

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

Remarks

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

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

Remarks

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

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

Remarks

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

Remarks

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

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

Remarks

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

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

Remarks

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

Remarks

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

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

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

Remarks

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

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

Remarks

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

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

Remarks

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

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

Remarks

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

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

Remarks

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

Remarks

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

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

Remarks

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