# IRTCRoomEventHandler ```java public abstract class com.ss.bytertc.engine.handler.IRTCRoomEventHandler ``` 房间事件回调接口注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onLeaveRoom](#IRTCRoomEventHandler-onleaveroom) | | void | [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) | | void | [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) | | void | [onAVSyncStateChange](#IRTCRoomEventHandler-onavsyncstatechange) | | void | [onRoomStats](#IRTCRoomEventHandler-onroomstats) | | void | [onUserJoined](#IRTCRoomEventHandler-onuserjoined) | | void | [onUserLeave](#IRTCRoomEventHandler-onuserleave) | | void | [onTokenWillExpire](#IRTCRoomEventHandler-ontokenwillexpire) | | void | [onPublishPrivilegeTokenWillExpire](#IRTCRoomEventHandler-onpublishprivilegetokenwillexpire) | | void | [onSubscribePrivilegeTokenWillExpire](#IRTCRoomEventHandler-onsubscribeprivilegetokenwillexpire) | | void | [onVideoPublishStateChanged](#IRTCRoomEventHandler-onvideopublishstatechanged) | | void | [onAudioPublishStateChanged](#IRTCRoomEventHandler-onaudiopublishstatechanged) | | void | [onVideoSubscribeStateChanged](#IRTCRoomEventHandler-onvideosubscribestatechanged) | | void | [onAudioSubscribeStateChanged](#IRTCRoomEventHandler-onaudiosubscribestatechanged) | | void | [onLocalStreamStats](#IRTCRoomEventHandler-onlocalstreamstats) | | void | [onRemoteStreamStats](#IRTCRoomEventHandler-onremotestreamstats) | | void | [onStreamSubscribed](#IRTCRoomEventHandler-onstreamsubscribed) | | void | [onAVSyncEvent](#IRTCRoomEventHandler-onavsyncevent) | | void | [onUserPublishStreamVideo](#IRTCRoomEventHandler-onuserpublishstreamvideo) | | void | [onUserPublishStreamAudio](#IRTCRoomEventHandler-onuserpublishstreamaudio) | | void | [onRoomMessageReceived](#IRTCRoomEventHandler-onroommessagereceived) | | void | [onRoomBinaryMessageReceived](#IRTCRoomEventHandler-onroombinarymessagereceived) | | void | [onUserMessageReceived](#IRTCRoomEventHandler-onusermessagereceived) | | void | [onUserBinaryMessageReceived](#IRTCRoomEventHandler-onuserbinarymessagereceived) | | void | [onRoomMessageReceived](#IRTCRoomEventHandler-onroommessagereceived-2) | | void | [onRoomBinaryMessageReceived](#IRTCRoomEventHandler-onroombinarymessagereceived-2) | | void | [onUserMessageReceived](#IRTCRoomEventHandler-onusermessagereceived-2) | | void | [onUserBinaryMessageReceived](#IRTCRoomEventHandler-onuserbinarymessagereceived-2) | | void | [onUserMessageSendResult](#IRTCRoomEventHandler-onusermessagesendresult) | | void | [onRoomMessageSendResult](#IRTCRoomEventHandler-onroommessagesendresult) | | void | [onVideoStreamBanned](#IRTCRoomEventHandler-onvideostreambanned) | | void | [onAudioStreamBanned](#IRTCRoomEventHandler-onaudiostreambanned) | | void | [onForwardStreamStateChanged](#IRTCRoomEventHandler-onforwardstreamstatechanged) | | void | [onForwardStreamEvent](#IRTCRoomEventHandler-onforwardstreamevent) | | void | [onNetworkQuality](#IRTCRoomEventHandler-onnetworkquality) | | void | [onSetRoomExtraInfoResult](#IRTCRoomEventHandler-onsetroomextrainforesult) | | void | [onRoomExtraInfoUpdate](#IRTCRoomEventHandler-onroomextrainfoupdate) | | void | [onRoomStreamExtraInfoUpdate](#IRTCRoomEventHandler-onroomstreamextrainfoupdate) | | void | [onUserVisibilityChanged](#IRTCRoomEventHandler-onuservisibilitychanged) | | void | [onSubtitleStateChanged](#IRTCRoomEventHandler-onsubtitlestatechanged) | | void | [onSubtitleMessageReceived](#IRTCRoomEventHandler-onsubtitlemessagereceived) | ## 函数说明 ### onLeaveRoom ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onLeaveRoom(RTCRoomStats stats) ``` 离开房间成功回调。用户调用 [leaveRoom](70080#RTSRoom-leaveroom) 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | RTCRoomStats | 保留参数，目前为空。 | **注意** - 用户调用 [leaveRoom](70080#RTSRoom-leaveroom) 方法离开房间后，如果立即调用 [destroy](70080#RTCRoom-destroy) 销毁房间实例或 [destroyRTCEngine](70080#RTCEngine-destroyrtcengine) 方法销毁 RTC 引擎，则将无法收到此回调事件。 - 离开房间后，如果 App 需要使用系统音视频设备，则建议在收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备导致初始化失败。 ### onRoomStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomStateChanged( String roomId, String uid, int state, String extraInfo ) ``` 房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID。 | | uid | String | 用户 ID。 | | state | int | 房间状态码。

0：加入房间成功。
!0：加入房间失败、异常退房、发生房间相关的警告或错误。具体原因参看 [ErrorCode](70082#ErrorCode) 及 [WarningCode](70082#WarningCode)。

| | extraInfo | String | 额外信息，如 `{"elapsed":1187,"join_type":0}`。
`join_type` 表示加入房间的类型，`0`为首次进房，`1`为重连进房。
`elapsed` 表示加入房间耗时，即本地用户从调用 [joinRoom](70080#RTCRoom-joinroom) 到加入房间成功所经历的时间间隔，单位为 ms。 | ### onStreamStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onStreamStateChanged( String roomId, String uid, int state, String extraInfo ) ``` 流状态改变回调，发生流相关的警告或错误时会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID。 | | uid | String | 用户 ID。 | | state | int | 流状态码，参看 [ErrorCode](70082#ErrorCode) 及 [WarningCode](70082#WarningCode)。 | | extraInfo | String | 附加信息，目前为空。 | ### onAVSyncStateChange ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAVSyncStateChange(AVSyncState state) ``` 发布端调用 [setMultiDeviceAVSync](70080#RTCRoom-setmultideviceavsync) 后音视频同步状态发生改变时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | AVSyncState | 音视频同步状态，参看 [AVSyncState](70083#AVSyncState)。 | ### onRoomStats ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomStats(RTCRoomStats stats) ``` 房间内通话统计信息回调。用户进房开始通话后，每 2s 收到一次本回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | RTCRoomStats | 房间内的汇总统计数据。详见 [RTCRoomStats](70083#RTCRoomStats)。 | ### onUserJoined ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserJoined(UserInfo userInfo) ``` 远端可见用户加入房间，或房内不可见用户切换为可见的回调。 1.远端用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。 2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。 3.房间内隐身远端用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 方法切换至可见时，房间内其他用户将收到该事件。 4.新进房用户也会收到进房前已在房内的可见用户的进房回调通知。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userInfo | UserInfo | 用户信息。参看 [UserInfo](70083#UserInfo)。 | ### onUserLeave ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserLeave( String uid, int reason ) ``` 远端用户离开房间，或切至不可见时，房间内其他用户会收到此事件 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 离开房间，或切至不可见的的远端用户 ID。 | | reason | int | 用户离开房间的原因：

0：远端用户调用 [leaveRoom](70080#RTSRoom-leaveroom) 主动退出房间。
1：远端用户因 Token 过期或网络原因等掉线。详细信息请参看[连接状态提示](https://www.volcengine.com/docs/6348/95376)
2：远端用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 切换至不可见状态。
3：服务端调用 OpenAPI 将该远端用户踢出房间。

| ### onTokenWillExpire ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onTokenWillExpire() ``` 当 SDK 检测到 Token 的进房权限将在 30 秒内过期时，触发该回调。收到该回调后，你需调用 [updateToken](70080#RTSRoom-updatetoken) 更新 Token 进房权限。 **注意** 若 Token 进房权限过期且未及时更新： - 用户此时尝试进房会收到 [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) 回调，提示错误码为 `-1000` Token 无效； - 用户已在房间内则会被移出房间，本地用户会收到 [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) 回调，提示错误码为 `-1009` Token 无效，同时远端用户会收到 [onUserLeave](#IRTCRoomEventHandler-onuserleave) 回调，提示原因为 `1` Token 进房权限过期。 ### onPublishPrivilegeTokenWillExpire ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onPublishPrivilegeTokenWillExpire() ``` Token 发布权限过期前 30 秒将触发该回调。收到该回调后，你需调用 [updateToken](70080#RTSRoom-updatetoken) 更新 Token 发布权限。 **注意** Token 发布权限过期后： - 已发布流或尝试发布流时，本端会收到 [onVideoPublishStateChanged](#IRTCRoomEventHandler-onvideopublishstatechanged)、[onAudioPublishStateChanged](#IRTCRoomEventHandler-onaudiopublishstatechanged) 回调，提示`kPublishStateChangeReasonNoPublishPermission`，没有发布权限。 - 发布中的流将停止发布。远端用户会收到 [onUserPublishStreamVideo](#IRTCRoomEventHandler-onuserpublishstreamvideo)、[onUserPublishStreamAudio](#IRTCRoomEventHandler-onuserpublishstreamaudio) 回调，提示该流已停止发布。 ### onSubscribePrivilegeTokenWillExpire ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSubscribePrivilegeTokenWillExpire() ``` Token 订阅权限过期前 30 秒将触发该回调。收到该回调后，你需调用 [updateToken](70080#RTSRoom-updatetoken) 更新 Token 订阅权限有效期。 **注意** 若收到该回调后未及时更新 Token，Token 订阅权限过期后，尝试新订阅流会失败，已订阅的流会取消订阅，可通过 [onVideoSubscribeStateChanged](#IRTCRoomEventHandler-onvideosubscribestatechanged)、[onAudioSubscribeStateChanged](#IRTCRoomEventHandler-onaudiosubscribestatechanged) 回调，提示错误码为 `-1003` 没有订阅权限。 ### onVideoPublishStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onVideoPublishStateChanged( String streamId, StreamInfo streamInfo, PublishState state, PublishStateChangeReason reason ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onStreamStateChanged` 方法中的本地视频发布状态变更通知功能。如果你已升级至 3.60 及以上版本 SDK，且还在使用该方法，请迁移至该回调。视频发布状态改变回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的视频流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | state | PublishState | 发布状态码，参看 [PublishState](70083#PublishState)。 | | reason | PublishStateChangeReason | 本地视频流发布状态改变的具体原因，参看 [PublishStateChangeReason](70083#PublishStateChangeReason)。 | ### onAudioPublishStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAudioPublishStateChanged( String streamId, StreamInfo streamInfo, PublishState state, PublishStateChangeReason reason ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onStreamStateChanged` 方法中的本地音频发布状态变更通知功能。如果你已升级至 3.60 及以上版本 SDK，且还在使用该方法，请迁移至该回调。音频发布状态改变回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的音频流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | state | PublishState | 发布状态码，参看 [PublishState](70083#PublishState)。 | | reason | PublishStateChangeReason | 本地音频流发布状态改变的具体原因，参看 [PublishStateChangeReason](70083#PublishStateChangeReason)。 | ### onVideoSubscribeStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onVideoSubscribeStateChanged( String streamId, StreamInfo streamInfo, SubscribeState state, SubscribeStateChangeReason reason ) ``` > Available since 3.60. 视频订阅状态发生改变回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的视频流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | state | SubscribeState | 订阅状态码，参看 [SubscribeState](70083#SubscribeState)。 | | reason | SubscribeStateChangeReason | 视频订阅状态改变的具体原因，参看 [SubscribeStateChangeReason](70083#SubscribeStateChangeReason)。 | **注意** 当调用 [subscribeStreamVideo](70080#RTCRoom-subscribestreamvideo) 后会收到该通知。 ### onAudioSubscribeStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAudioSubscribeStateChanged( String streamId, StreamInfo streamInfo, SubscribeState state, SubscribeStateChangeReason reason ) ``` > Available since 3.60. 音频订阅状态发生改变回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的音频流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | state | SubscribeState | 订阅状态码，参看 [SubscribeState](70083#SubscribeState)。 | | reason | SubscribeStateChangeReason | 音频订阅状态改变的具体原因，参看 [SubscribeStateChangeReason](70083#SubscribeStateChangeReason)。 | **注意** 当调用 [subscribeStreamAudio](70080#RTCRoom-subscribestreamaudio) 后会收到该通知。 ### onLocalStreamStats ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onLocalStreamStats( String streamId, StreamInfo streamInfo, LocalStreamStats stats ) ``` 本地流数据统计以及网络质量回调。本地用户发布流成功后，SDK 会周期性（2s）的通过此回调事件通知用户发布的流在此次统计周期内的质量统计信息。统计信息通过 [LocalStreamStats](70083#LocalStreamStats) 类型的回调参数传递给用户，其中包括发送音视频比特率、发送帧率、编码帧率，网络质量等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的本地流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | stats | LocalStreamStats | 音视频流以及网络状况统计信息。参见 [LocalStreamStats](70083#LocalStreamStats)。 | ### onRemoteStreamStats ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRemoteStreamStats( String streamId, StreamInfo streamInfo, RemoteStreamStats stats ) ``` 本地订阅的远端音/视频流数据统计以及网络质量回调。本地用户订阅流成功后，SDK 会周期性（2s）的通过此回调事件通知用户订阅的流在此次统计周期内的质量统计信息，包括：发送音视频比特率、发送帧率、编码帧率，网络质量等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的远端流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | stats | RemoteStreamStats | 音视频流以及网络状况统计信息。参见 [RemoteStreamStats](70083#RemoteStreamStats)。 | ### onStreamSubscribed ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onStreamSubscribed( int stateCode, String userId, SubscribeConfig info ) ``` 关于订阅媒体流状态改变的回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stateCode | int | 订阅媒体流状态，参看 [SubscribeState](70083#SubscribeState) | | userId | String | 流发布用户的用户 ID | | info | SubscribeConfig | 流的属性，参看 [SubscribeConfig](70083#SubscribeConfig) | **注意** 本地用户收到该回调的时机：调用 [subscribeStreamVideo](70080#RTCRoom-subscribestreamvideo) 订阅/取消订阅指定远端摄像头音视频流后。 ### onAVSyncEvent ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAVSyncEvent( String roomId, String uid, AVSyncEvent eventCode ) ``` > Available since 3.60. 发布端调用 [setMultiDeviceAVSync](70080#RTCRoom-setmultideviceavsync) 后音视频同步状态发生错误时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID。 | | uid | String | 用户 ID。 | | eventCode | AVSyncEvent | 音视频同步状态错误，参看 [AVSyncEvent](70083#AVSyncEvent)。 | ### onUserPublishStreamVideo ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserPublishStreamVideo( String streamId, StreamInfo streamInfo, boolean isPublish ) ``` > Available since 3.60. 自版本 3.60 起，该回调替换了 `onUserPublishStream`、`onUserUnpublishStream`、`onUserPublishScreen` 和 `onUserUnpublishScreen` 方法。如果您已升级到 SDK 版本 3.60 或以上，且仍在使用这两个方法，请迁移至该回调。房间内远端用户发布或取消发布视频流的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的视频流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | isPublish | boolean | 远端用户是否发布视频流。

`true`：已发布。
`false`：已取消发布或未发布。

| **注意** 当房间内的远端用户调用 [publishStreamVideo](70080#RTCRoom-publishstreamvideo) 发布或取消发布由摄像头采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 [subscribeStreamVideo](70080#RTCRoom-subscribestreamvideo) 订阅或取消订阅此流。 ### onUserPublishStreamAudio ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserPublishStreamAudio( String streamId, StreamInfo streamInfo, boolean isPublish ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onUserPublishStream`、`onUserUnpublishStream`、`onUserPublishScreen` 和 `onUserUnpublishScreen` 方法来实现下述功能。如果你已升级至 3.60 及以上版本 SDK，且还在使用这两个方法，请迁移至该回调。房间内远端用户发布或取消发布音频流的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID，用于标识特定的音频流。 | | streamInfo | StreamInfo | 流信息结构体，包含房间 ID、用户 ID 等详细信息，参看 [StreamInfo](70083#StreamInfo)。 | | isPublish | boolean | 远端用户是否发布音频流。

`true`：已发布。
`false`：已取消发布或未发布。

| **注意** 当房间内的远端用户调用 [publishStreamAudio](70080#RTCRoom-publishstreamaudio) 发布或取消发布音频流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 [subscribeStreamAudio](70080#RTCRoom-subscribestreamaudio) 订阅或取消订阅此流。 ### onRoomMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomMessageReceived( String uid, String message ) ``` > 该接口将于 3.64 [onRoomMessageReceived](#IRTCRoomEventHandler-onroommessagereceived-2) 代替。接收到房间内广播消息的回调。房间内其他用户调用 [sendRoomMessage](70080#RTSRoom-sendroommessage) 发送广播消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者 ID | | message | String | 收到的消息内容 | ### onRoomBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomBinaryMessageReceived( String uid, ByteBuffer message ) ``` > 该接口将于 3.64 [onRoomBinaryMessageReceived](#IRTCRoomEventHandler-onroombinarymessagereceived-2) 代替。收到房间内广播二进制消息的回调。房间内其他用户调用 [sendRoomBinaryMessage](70080#RTSRoom-sendroombinarymessage) 发送广播二进制消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onUserMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserMessageReceived( String uid, String message ) ``` > 该接口将于 3.64 [onUserMessageReceived](#IRTCRoomEventHandler-onusermessagereceived-2) 代替。收到来自房间中其他用户通过 [sendUserMessage](70080#RTSRoom-sendusermessage) 发来的点对点文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者的用户 ID。 | | message | String | 收到的文本消息内容。 | ### onUserBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserBinaryMessageReceived( String uid, ByteBuffer message ) ``` > 该接口将于 3.64 [onUserBinaryMessageReceived](#IRTCRoomEventHandler-onuserbinarymessagereceived-2) 代替。收到来自房间中其他用户通过 [sendUserBinaryMessage](70080#RTSRoom-senduserbinarymessage) 发来的点对点二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者的用户 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onRoomMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomMessageReceived( long msgid, String uid, String message ) ``` 接收到房间内广播消息的回调。房间内其他用户调用 [sendRoomMessage](70080#RTSRoom-sendroommessage) 发送广播消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号。 | | uid | String | 消息发送者 ID。 | | message | String | 收到的消息内容。 | ### onRoomBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomBinaryMessageReceived( long msgid, String uid, ByteBuffer message ) ``` 收到房间内广播二进制消息的回调。房间内其他用户调用 [sendRoomBinaryMessage](70080#RTSRoom-sendroombinarymessage) 发送广播二进制消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号。 | | uid | String | 消息发送者 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onUserMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserMessageReceived( long msgid, String uid, String message ) ``` 收到来自房间中其他用户通过 [sendUserMessage](70080#RTSRoom-sendusermessage) 发来的点对点文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号。 | | uid | String | 消息发送者的用户 ID。 | | message | String | 收到的文本消息内容。 | ### onUserBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserBinaryMessageReceived( long msgid, String uid, ByteBuffer message ) ``` 收到来自房间中其他用户通过 [sendUserBinaryMessage](70080#RTSRoom-senduserbinarymessage) 发来的点对点二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号。 | | uid | String | 消息发送者的用户 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onUserMessageSendResult ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserMessageSendResult( long msgid, int error ) ``` 向房间内单个用户发送文本或二进制消息后（P2P），消息发送方会收到该消息发送结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 本条消息的 ID。 | | error | int | 文本或二进制消息发送结果，详见 [UserMessageSendResult](70082#UserMessageSendResult) | **注意** 调用 [sendUserMessage](70080#RTSRoom-sendusermessage) 或 [sendUserBinaryMessage](70080#RTSRoom-senduserbinarymessage) 接口，才能收到此回调。 ### onRoomMessageSendResult ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomMessageSendResult( long msgid, int error ) ``` 调用 [sendRoomMessage](70080#RTSRoom-sendroommessage) 或 [sendRoomBinaryMessage](70080#RTSRoom-sendroombinarymessage) 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 本条消息的 ID。 | | error | int | 消息发送结果，详见 [RoomMessageSendResult](70082#RoomMessageSendResult) | ### onVideoStreamBanned ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onVideoStreamBanned( String uid, boolean banned ) ``` 通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 被禁用/解禁的视频流用户 ID | | banned | boolean | 视频流发送状态

true：视频流发送被禁用
false：视频流发送被解禁

| **注意** - 房间内指定用户被禁止/解禁视频流发送时，房间内所有用户都会收到该回调。 - 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。 - 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。 - 同一房间解散后再次创建，房间内状态清空。 ### onAudioStreamBanned ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAudioStreamBanned( String uid, boolean banned ) ``` 通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时，触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 被禁用/解禁的音频流用户 ID | | banned | boolean | 音频流发送状态

true：音频流发送被禁用
false：音频流发送被解禁

| **注意** - 房间内指定用户被禁止/解禁音频流发送时，房间内所有用户都会收到该回调。 - 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。 - 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。 - 在控制台开启音频选路后，只有被封禁/解禁用户会收到该回调。 - 同一房间解散后再次创建，房间内状态清空。 ### onForwardStreamStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onForwardStreamStateChanged(ForwardStreamStateInfo[] stateInfos) ``` 跨房间媒体流转发状态和错误回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stateInfos | ForwardStreamStateInfo [] | 跨房间媒体流转发目标房间信息数组，详见 [ForwardStreamStateInfo](70083#ForwardStreamStateInfo) | ### onForwardStreamEvent ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onForwardStreamEvent(ForwardStreamEventInfo[] eventInfos) ``` 跨房间媒体流转发事件回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | eventInfos | ForwardStreamEventInfo [] | 跨房间媒体流转发目标房间事件数组，详见 [ForwardStreamEventInfo](70083#ForwardStreamEventInfo) | ### onNetworkQuality ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onNetworkQuality( NetworkQualityStats localQuality, NetworkQualityStats[] remoteQualities ) ``` 加入房间并发布或订阅流后，以每 2 秒一次的频率，报告本地用户和已订阅的远端用户的上下行网络质量信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | localQuality | NetworkQualityStats | 本地网络质量，详见 [NetworkQualityStats](70083#NetworkQualityStats)。 | | remoteQualities | NetworkQualityStats [] | 已订阅用户的网络质量，详见 [NetworkQualityStats](70083#NetworkQualityStats)。 | **注意** 更多通话中的监测接口，详见[通话中质量监测](https://www.volcengine.com/docs/6348/106866)。 ### onSetRoomExtraInfoResult ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSetRoomExtraInfoResult( long taskId, SetRoomExtraInfoResult result ) ``` > Available since 3.52 调用 [setRoomExtraInfo](70080#RTCRoom-setroomextrainfo) 设置房间附加信息结果的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | taskId | long | 调用 setRoomExtraInfo 的任务编号。 | | result | SetRoomExtraInfoResult | 设置房间附加信息的结果，详见 [SetRoomExtraInfoResult](70083#SetRoomExtraInfoResult) | ### onRoomExtraInfoUpdate ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomExtraInfoUpdate( String key, String value, String lastUpdateUserId, long lastUpdateTimeMs ) ``` > Available since 3.52 接收同一房间内，其他用户调用 [setRoomExtraInfo](70080#RTCRoom-setroomextrainfo) 设置的房间附加信息的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | String | 房间附加信息的键值 | | value | String | 房间附加信息的内容 | | lastUpdateUserId | String | 最后更新本条信息的用户 ID。 | | lastUpdateTimeMs | long | 最后更新本条信息的 Unix 时间，单位：毫秒。 | **注意** 新进房的用户会收到进房前房间内已有的全部附加信息通知。 ### onRoomStreamExtraInfoUpdate ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomStreamExtraInfoUpdate( String streamId, StreamInfo streamInfo, String extraInfo ) ``` > Available since 3.54 接收同一房间内，其他用户调用 [setStreamExtraInfo](70080#RTCRoom-setstreamextrainfo) 设置的流附加信息的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流附加信息的流 ID | | streamInfo | StreamInfo | 流附加信息的流信息 | | extraInfo | String | 流附加信息 | **注意** 新进房的用户会收到进房前房间内已有的全部附加信息通知。 ### onUserVisibilityChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserVisibilityChanged( boolean currentUserVisibility, UserVisibilityChangeError errorCode ) ``` > Available since 3.54 用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 设置用户可见性的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | currentUserVisibility | boolean | 当前用户的可见性。

true：可见，用户可以在房间内发布音视频流，房间中的其他用户将收到用户的行为通知，例如进房、开启视频采集和退房。
false：不可见，用户不可以在房间内发布音视频流，房间中的其他用户不会收到用户的行为通知，例如进房、开启视频采集和退房。

| | errorCode | UserVisibilityChangeError | 设置用户可见性错误码，参看 [UserVisibilityChangeError](70083#UserVisibilityChangeError)。 | ### onSubtitleStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSubtitleStateChanged( SubtitleState state, SubtitleErrorCode errorCode, String errorMessage ) ``` 字幕状态发生改变回调。当用户调用 [startSubtitle](70080#RTCRoom-startsubtitle) 和 [stopSubtitle](70080#RTCRoom-stopsubtitle) 使字幕状态发生改变或字幕任务出现错误时，触发该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | SubtitleState | 字幕状态。参看 [SubtitleState](70083#SubtitleState)。 | | errorCode | SubtitleErrorCode | 字幕任务错误码。参看 [SubtitleErrorCode](70082#SubtitleErrorCode)。 | | errorMessage | String | 与第三方服务有关的错误信息。 | ### onSubtitleMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSubtitleMessageReceived(SubtitleMessage[] subtitles) ``` 字幕相关内容回调。当用户成功调用 [startSubtitle](70080#RTCRoom-startsubtitle) 后会收到此回调，通知字幕的相关信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subtitles | SubtitleMessage [] | 字幕消息内容。参看 [SubtitleMessage](70083#SubtitleMessage)。 | # IAudioEffectPlayerEventHandler ```java public interface com.ss.bytertc.engine.IAudioEffectPlayerEventHandler ``` [IAudioEffectPlayer](70080#IAudioEffectPlayer) 对应的回调句柄。你必须调用 [setEventHandler](70080#IAudioEffectPlayer-seteventhandler) 完成设置后，才能收到对应回调。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onAudioEffectPlayerStateChanged](#IAudioEffectPlayerEventHandler-onaudioeffectplayerstatechanged) | ## 函数说明 ### onAudioEffectPlayerStateChanged ```java void com.ss.bytertc.engine.IAudioEffectPlayerEventHandler.onAudioEffectPlayerStateChanged( int effectId, PlayerState state, PlayerError error ) ``` 播放状态改变时回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | effectId | int | [IAudioEffectPlayer](70080#IAudioEffectPlayer) 的 ID。通过 [getAudioEffectPlayer](70080#RTCEngine-getaudioeffectplayer) 设置。 | | state | PlayerState | 混音状态。参考 [PlayerState](70083#PlayerState)。 | | error | PlayerError | 错误码。参考 [PlayerError](70083#PlayerError)。 | # IRTCEngineEventHandler ```java public abstract class com.ss.bytertc.engine.handler.IRTCEngineEventHandler ``` 音视频引擎事件回调接口注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onWarning](#IRTCEngineEventHandler-onwarning) | | void | [onError](#IRTCEngineEventHandler-onerror) | | void | [onExtensionAccessError](#IRTCEngineEventHandler-onextensionaccesserror) | | void | [onSysStats](#IRTCEngineEventHandler-onsysstats) | | void | [onNetworkTypeChanged](#IRTCEngineEventHandler-onnetworktypechanged) | | void | [onUserStartVideoCapture](#IRTCEngineEventHandler-onuserstartvideocapture) | | void | [onUserStopVideoCapture](#IRTCEngineEventHandler-onuserstopvideocapture) | | void | [onUserStartAudioCapture](#IRTCEngineEventHandler-onuserstartaudiocapture) | | void | [onUserStopAudioCapture](#IRTCEngineEventHandler-onuserstopaudiocapture) | | void | [onLocalAudioStateChanged](#IRTCEngineEventHandler-onlocalaudiostatechanged) | | void | [onRemoteAudioStateChanged](#IRTCEngineEventHandler-onremoteaudiostatechanged) | | void | [onLocalVideoStateChanged](#IRTCEngineEventHandler-onlocalvideostatechanged) | | void | [onRemoteVideoStateChanged](#IRTCEngineEventHandler-onremotevideostatechanged) | | void | [onFirstRemoteVideoFrameRendered](#IRTCEngineEventHandler-onfirstremotevideoframerendered) | | void | [onFirstRemoteVideoFrameDecoded](#IRTCEngineEventHandler-onfirstremotevideoframedecoded) | | void | [onFirstLocalVideoFrameCaptured](#IRTCEngineEventHandler-onfirstlocalvideoframecaptured) | | void | [onLocalVideoSizeChanged](#IRTCEngineEventHandler-onlocalvideosizechanged) | | void | [onRemoteVideoSizeChanged](#IRTCEngineEventHandler-onremotevideosizechanged) | | void | [onConnectionStateChanged](#IRTCEngineEventHandler-onconnectionstatechanged) | | void | [onAudioRouteChanged](#IRTCEngineEventHandler-onaudioroutechanged) | | void | [onFirstLocalAudioFrame](#IRTCEngineEventHandler-onfirstlocalaudioframe) | | void | [onFirstRemoteAudioFrame](#IRTCEngineEventHandler-onfirstremoteaudioframe) | | void | [onLogReport](#IRTCEngineEventHandler-onlogreport) | | void | [onSEIMessageReceived](#IRTCEngineEventHandler-onseimessagereceived) | | void | [onSEIStreamUpdate](#IRTCEngineEventHandler-onseistreamupdate) | | void | [onLoginResult](#IRTCEngineEventHandler-onloginresult) | | void | [onLogout](#IRTCEngineEventHandler-onlogout) | | void | [onServerParamsSetResult](#IRTCEngineEventHandler-onserverparamssetresult) | | void | [onGetPeerOnlineStatus](#IRTCEngineEventHandler-ongetpeeronlinestatus) | | void | [onUserMessageReceivedOutsideRoom](#IRTCEngineEventHandler-onusermessagereceivedoutsideroom) | | void | [onUserBinaryMessageReceivedOutsideRoom](#IRTCEngineEventHandler-onuserbinarymessagereceivedoutsideroom) | | void | [onUserMessageReceivedOutsideRoom](#IRTCEngineEventHandler-onusermessagereceivedoutsideroom-2) | | void | [onUserBinaryMessageReceivedOutsideRoom](#IRTCEngineEventHandler-onuserbinarymessagereceivedoutsideroom-2) | | void | [onUserMessageSendResultOutsideRoom](#IRTCEngineEventHandler-onusermessagesendresultoutsideroom) | | void | [onServerMessageSendResult](#IRTCEngineEventHandler-onservermessagesendresult) | | void | [onNetworkDetectionResult](#IRTCEngineEventHandler-onnetworkdetectionresult) | | void | [onNetworkDetectionStopped](#IRTCEngineEventHandler-onnetworkdetectionstopped) | | void | [onAudioDeviceStateChanged](#IRTCEngineEventHandler-onaudiodevicestatechanged) | | void | [onVideoDeviceStateChanged](#IRTCEngineEventHandler-onvideodevicestatechanged) | | void | [onAudioDeviceWarning](#IRTCEngineEventHandler-onaudiodevicewarning) | | void | [onVideoDeviceWarning](#IRTCEngineEventHandler-onvideodevicewarning) | | void | [onRecordingStateUpdate](#IRTCEngineEventHandler-onrecordingstateupdate) | | void | [onRecordingProgressUpdate](#IRTCEngineEventHandler-onrecordingprogressupdate) | | void | [onAudioRecordingStateUpdate](#IRTCEngineEventHandler-onaudiorecordingstateupdate) | | void | [onAudioMixingPlayingProgress](#IRTCEngineEventHandler-onaudiomixingplayingprogress) | | void | [onLocalAudioPropertiesReport](#IRTCEngineEventHandler-onlocalaudiopropertiesreport) | | void | [onAudioPlaybackDeviceTestVolume](#IRTCEngineEventHandler-onaudioplaybackdevicetestvolume) | | void | [onRemoteAudioPropertiesReport](#IRTCEngineEventHandler-onremoteaudiopropertiesreport) | | void | [onActiveSpeaker](#IRTCEngineEventHandler-onactivespeaker) | | void | [onEchoTestResult](#IRTCEngineEventHandler-onechotestresult) | | void | [onCloudProxyConnected](#IRTCEngineEventHandler-oncloudproxyconnected) | | void | [onNetworkTimeSynchronized](#IRTCEngineEventHandler-onnetworktimesynchronized) | | void | [onHardwareEchoDetectionResult](#IRTCEngineEventHandler-onhardwareechodetectionresult) | | void | [onLocalProxyStateChanged](#IRTCEngineEventHandler-onlocalproxystatechanged) | | void | [onStreamSyncInfoReceived](#IRTCEngineEventHandler-onstreamsyncinforeceived) | | void | [onRemoteSnapshotTakenToFile](#IRTCEngineEventHandler-onremotesnapshottakentofile) | | void | [onLocalSnapshotTakenToFile](#IRTCEngineEventHandler-onlocalsnapshottakentofile) | | void | [onAudioFrameSendStateChanged](#IRTCEngineEventHandler-onaudioframesendstatechanged) | | void | [onVideoFrameSendStateChanged](#IRTCEngineEventHandler-onvideoframesendstatechanged) | | void | [onAudioFramePlayStateChanged](#IRTCEngineEventHandler-onaudioframeplaystatechanged) | | void | [onVideoFramePlayStateChanged](#IRTCEngineEventHandler-onvideoframeplaystatechanged) | | void | [onSimulcastSubscribeFallback](#IRTCEngineEventHandler-onsimulcastsubscribefallback) | | void | [onPerformanceAlarms](#IRTCEngineEventHandler-onperformancealarms) | | void | [onMixedStreamEvent](#IRTCEngineEventHandler-onmixedstreamevent) | | void | [onSingleStreamEvent](#IRTCEngineEventHandler-onsinglestreamevent) | | void | [deprecated] [onPushPublicStreamResult](#IRTCEngineEventHandler-onpushpublicstreamresult) | ## 函数说明 ### onWarning ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onWarning(int warn) ``` 发生警告回调。 SDK 运行时出现了警告。SDK 通常会自动恢复，警告信息可以忽略。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | warn | int | 警告代码，参见 [WarningCode](70082#WarningCode) | ### onError ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onError(int err) ``` 发生错误回调。 SDK 运行时出现了网络或媒体相关的错误，且无法自动恢复时触发此回调。你可能需要干预. **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | err | int | 错误代码，详情定义见：[ErrorCode](70082#ErrorCode) | ### onExtensionAccessError ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onExtensionAccessError( String extensionName, String msg ) ``` > Available since 3.52 当访问插件失败时，收到此回调。 RTC SDK 将一些功能封装成插件。当使用这些功能时，如果插件不存在，功能将无法使用。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | extensionName | String | 插件名字 | | msg | String | 失败说明 | ### onSysStats ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onSysStats(SysStats stats) ``` 每 2 秒发生回调，通知当前 cpu，内存使用的信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | SysStats | cpu，内存信息。详见 [SysStats](70083#SysStats) 数据类型。 | ### onNetworkTypeChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onNetworkTypeChanged(int type) ``` SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | int | 网络类型。

-1：网络连接类型未知。
0：网络连接已断开。
1：LAN
2：Wi-Fi,包含热点
3：2G 移动网络
4：3G 移动网络
5：4G 移动网络
6：5G 移动网络

| ### onUserStartVideoCapture ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserStartVideoCapture( String streamId, StreamInfo streamInfo ) ``` 房间内的可见用户调用 [startVideoCapture](70080#RTCEngine-startvideocapture) 开启内部视频采集时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 视频流 ID | | streamInfo | StreamInfo | 视频流信息，详见 [StreamInfo](70083#StreamInfo)。 | ### onUserStopVideoCapture ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserStopVideoCapture( String streamId, StreamInfo streamInfo ) ``` 房间内的可见用户调用 [stopVideoCapture](70080#RTCEngine-stopvideocapture) 关闭内部视频采集时，房间内其他用户会收到此回调。若发布视频数据前未开启采集，房间内所有可见用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 视频流 ID | | streamInfo | StreamInfo | 视频流信息，详见 [StreamInfo](70083#StreamInfo)。 | ### onUserStartAudioCapture ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserStartAudioCapture( String streamId, StreamInfo streamInfo ) ``` 房间内的用户调用 [startAudioCapture](70080#RTCEngine-startaudiocapture) 开启音频采集时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 开启音频采集的远端流 ID | | streamInfo | StreamInfo | 开启音频采集的远端流信息，详见 [StreamInfo](70083#StreamInfo) | ### onUserStopAudioCapture ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserStopAudioCapture( String streamId, StreamInfo streamInfo ) ``` 房间内的用户调用 [stopAudioCapture](70080#RTCEngine-stopaudiocapture) 关闭音频采集时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，详见 [StreamInfo](70083#StreamInfo) | ### onLocalAudioStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLocalAudioStateChanged( IAudioSource audioSource, LocalAudioStreamState state, LocalAudioStreamError error ) ``` 本地音频流的状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioSource | IAudioSource | 预留参数 | | state | LocalAudioStreamState | 本地音频设备的状态，详见 [LocalAudioStreamState](70083#LocalAudioStreamState) | | error | LocalAudioStreamError | 本地音频流状态改变时的错误码，详见 [LocalAudioStreamError](70083#LocalAudioStreamError) | ### onRemoteAudioStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRemoteAudioStateChanged( String streamId, StreamInfo streamInfo, RemoteAudioState state, RemoteAudioStateChangeReason reason ) ``` 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息, 详见 [StreamInfo](70083#StreamInfo) | | state | RemoteAudioState | 远端音频流状态，详见 [RemoteAudioState](70083#RemoteAudioState) | | reason | RemoteAudioStateChangeReason | 远端音频流状态改变的原因，详见 [RemoteAudioStateChangeReason](70083#RemoteAudioStateChangeReason) | ### onLocalVideoStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLocalVideoStateChanged( IVideoSource videoSource, LocalVideoStreamState state, LocalVideoStreamError error ) ``` 本地视频流的状态发生改变时，收到该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数 | | state | LocalVideoStreamState | 本地视频流状态，参看 [LocalVideoStreamState](70083#LocalVideoStreamState) | | error | LocalVideoStreamError | 本地视频状态改变时的错误码，参看 [LocalVideoStreamError](70083#LocalVideoStreamError) | ### onRemoteVideoStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRemoteVideoStateChanged( String streamId, StreamInfo streamInfo, RemoteVideoState videoState, RemoteVideoStateChangeReason videoStateReason ) ``` 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息, 详见 [StreamInfo](70083#StreamInfo) | | videoState | RemoteVideoState | 远端视频流状态，参看 [RemoteVideoState](70083#RemoteVideoState) | | videoStateReason | RemoteVideoStateChangeReason | 远端视频流状态改变原因，参看 [RemoteVideoStateChangeReason](70083#RemoteVideoStateChangeReason) | **注意** 本回调仅适用于主流，不适用于屏幕流。 ### onFirstRemoteVideoFrameRendered ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onFirstRemoteVideoFrameRendered( String streamId, StreamInfo streamInfo, VideoFrameInfo frameInfo ) ``` SDK 内部渲染成功远端视频流首帧后，收到此回调。包含以下情况： 1. 发布端首次发布视频 2. 在 1 条件下，发布端取消发布视频后，再次发布视频 3. 在 1 条件下，发布端关闭视频采集后，再次打开采集（或使用外部源时，停止推流后再次推流） 4. 在 1 条件下，订阅端取消订阅视频后，再次订阅视频（调用接口包括 [subscribeAllStreamsVideo](70080#RTCRoom-subscribeallstreamsvideo)，[pauseAllSubscribedStreamVideo](70080#RTCRoom-pauseallsubscribedstreamvideo)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息, 详见 [StreamInfo](70083#StreamInfo) | | frameInfo | VideoFrameInfo | 视频帧信息，参看 [VideoFrameInfo](70083#VideoFrameInfo) | **注意** 仅在采用内部渲染时，符合上述策略。 ### onFirstRemoteVideoFrameDecoded ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onFirstRemoteVideoFrameDecoded( String streamId, StreamInfo streamInfo, VideoFrameInfo frameInfo ) ``` 订阅端接收并解码远端视频流首帧时，收到此回调。包含以下情况： 1. 发布端发布视频，包含首次发布和取消后再次发布。 2. 发布端关闭视频采集后，再次打开采集。使用外部源时，停止推流后再次推流。 3. 发布端发布视频后，订阅端取消订阅视频后，又再次订阅视频。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息, 详见 [StreamInfo](70083#StreamInfo) | | frameInfo | VideoFrameInfo | 视频帧信息，参看 [VideoFrameInfo](70083#VideoFrameInfo) | **注意** - 用户刚收到房间内订阅的每一路视频流时，都会收到该回调。 - 摄像头流、屏幕流，内部采集、外部源，自动订阅和手动订阅的视频流，都符合上述策略。 ### onFirstLocalVideoFrameCaptured ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onFirstLocalVideoFrameCaptured( IVideoSource videoSource, VideoFrameInfo frameInfo ) ``` RTC SDK 在本地完成第一帧视频帧或屏幕视频帧采集时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数。 | | frameInfo | VideoFrameInfo | 视频信息，参看 [VideoFrameInfo](70083#VideoFrameInfo) | **注意** 对于采集到的本地视频帧，你可以调用 [setLocalVideoCanvas](70080#RTCEngine-setlocalvideocanvas) 或 [setLocalVideoSink](70080#RTCEngine-setlocalvideosink) 在本地渲染。 ### onLocalVideoSizeChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLocalVideoSizeChanged( IVideoSource videoSource, VideoFrameInfo frameInfo ) ``` 本地预览视频大小或旋转信息发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数。 | | frameInfo | VideoFrameInfo | 视频帧信息，参看 [VideoFrameInfo](70083#VideoFrameInfo) | ### onRemoteVideoSizeChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRemoteVideoSizeChanged( String streamId, StreamInfo streamInfo, VideoFrameInfo frameInfo ) ``` 远端视频大小或旋转信息发生改变时，房间内订阅此视频流的用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息, 详见 [StreamInfo](70083#StreamInfo) | | frameInfo | VideoFrameInfo | 视频帧信息，参看 [VideoFrameInfo](70083#VideoFrameInfo) | ### onConnectionStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onConnectionStateChanged( int state, int reason ) ``` 回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | int | 当前 SDK 与信令服务器连接状态。详细定义参见 [ConnectionState](70083#ConnectionState) | | reason | int | 引起信令服务器连接状态发生改变的原因，目前未启用固定为 -1 。 | **注意** 更多信息参见 [连接状态提示](https://www.volcengine.com/docs/6348/95376)。 ### onAudioRouteChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioRouteChanged(AudioRoute route) ``` 音频播放路由变化时，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | route | AudioRoute | 新的音频播放路由，详见 [AudioRoute](70083#AudioRoute) | **注意** 插拔音频外设，或调用 [setAudioRoute](70080#RTCEngine-setaudioroute) 都可能触发音频路由切换，详见[移动端设置音频路由](https://www.volcengine.com/docs/6348/117836) 。 ### onFirstLocalAudioFrame ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onFirstLocalAudioFrame(IAudioSource audioSource) ``` 发布音频流时，采集到第一帧音频帧，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioSource | IAudioSource | 预留参数 | **注意** 如果发布音频流时，未开启本地音频采集，SDK 会推送静音帧，也会收到此回调。 ### onFirstRemoteAudioFrame ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onFirstRemoteAudioFrame( String streamId, StreamInfo streamInfo ) ``` 订阅端接收并解码远端音频流首帧时，收到此回调。包含以下情况： 1. 发布端发布音频，包含首次发布和取消后再次发布。 2. 发布端关闭音频采集后，再次打开采集。使用外部源时，停止推流后再次推流。 3. 发布端发布音频后，订阅端取消订阅音频后，又再次订阅音频。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息, 详见 [StreamInfo](70083#StreamInfo) | **注意** - 用户刚收到房间内订阅的每一路音频流时，都会收到该回调。 - 摄像头流、屏幕流，内部采集、外部源、自动订阅和手动订阅的音频流，都符合上述策略。 ### onLogReport ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLogReport( String logType, JSONObject logContent ) ``` 上报日志时回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | logType | String | 日志类型。 | | logContent | JSONObject | 日志内容。 | ### onSEIMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onSEIMessageReceived( String streamId, StreamInfo streamInfo, ByteBuffer message ) ``` 收到通过调用 [sendSEIMessage](70080#RTCEngine-sendseimessage) 发送带有 SEI 消息的视频帧时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 包含 SEI 发送者的流 ID | | streamInfo | StreamInfo | 包含 SEI 发送者的流信息, 详见 [StreamInfo](70083#StreamInfo) | | message | ByteBuffer | 收到的 SEI 消息内容 | ### onSEIStreamUpdate ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onSEIStreamUpdate( String streamId, StreamInfo streamInfo, SEIStreamUpdateEvent event ) ``` 黑帧视频流发布状态回调。在语音通话场景下，本地用户调用 [sendSEIMessage](70080#RTCEngine-sendseimessage) 通过黑帧视频流发送 SEI 数据时，流的发送状态会通过该回调通知远端用户。你可以通过此回调判断携带 SEI 数据的视频帧为黑帧，从而不对该视频帧进行渲染。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息，参看 [StreamInfo](70083#StreamInfo)。 | | event | SEIStreamUpdateEvent | 黑帧视频流状态，参看 [SEIStreamUpdateEvent](70083#SEIStreamUpdateEvent) | ### onLoginResult ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLoginResult( String uid, int errorCode, int elapsed ) ``` 登录结果回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 登录用户 ID | | errorCode | int | 登录结果
详见 [LoginErrorCode](70082#LoginErrorCode)。 | | elapsed | int | 从调用 [login](70080#RTCEngine-login) 接口开始到返回结果所用时长。
单位为 ms。 | **注意** 调用 [login](70080#RTCEngine-login) 后，会收到此回调。 ### onLogout ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLogout(int reason) ``` 登出结果回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | reason | int | 用户登出的原因，参看 [LogoutReason](70083#LogoutReason) | **注意** 在以下两种情况下会收到此回调：调用 [logout](70080#RTCEngine-logout) 接口主动退出；或其他用户以相同 UserId 进行 `login` 导致本地用户被动登出。 ### onServerParamsSetResult ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onServerParamsSetResult(int error) ``` 设置应用服务器参数的返回结果 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | error | int | 设置结果

返回 200，设置成功
返回其他，设置失败，详见 [UserMessageSendResult](70082#UserMessageSendResult)

| **注意** 调用 [setServerParams](70080#RTCEngine-setserverparams) 后，会收到此回调。 ### onGetPeerOnlineStatus ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onGetPeerOnlineStatus( String peerUserId, int status ) ``` 查询对端或本端用户登录状态的返回结果 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | peerUserId | String | 需要查询的用户 ID | | status | int | 查询的用户登录状态
详见 [UserOnlineStatus](70083#UserOnlineStatus). | **注意** 必须先调用 [getPeerOnlineStatus](70080#RTCEngine-getpeeronlinestatus)，才能收到此回调。 ### onUserMessageReceivedOutsideRoom ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserMessageReceivedOutsideRoom( String uid, String message ) ``` > 该接口将于 3.64 [onUserMessageReceivedOutsideRoom](#IRTCEngineEventHandler-onusermessagereceivedoutsideroom-2) 代替。收到房间外用户调用 [sendUserMessageOutsideRoom](70080#RTCEngine-sendusermessageoutsideroom) 发来的文本消息时，会收到此回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者 ID。 | | message | String | 收到的文本消息内容。 | ### onUserBinaryMessageReceivedOutsideRoom ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserBinaryMessageReceivedOutsideRoom( String uid, ByteBuffer message ) ``` > 该接口将于 3.64 [onUserBinaryMessageReceivedOutsideRoom](#IRTCEngineEventHandler-onuserbinarymessagereceivedoutsideroom-2) 代替。收到房间外用户调用 [sendUserBinaryMessageOutsideRoom](70080#RTCEngine-senduserbinarymessageoutsideroom) 发来的二进制消息时，会收到此回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onUserMessageReceivedOutsideRoom ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserMessageReceivedOutsideRoom( long msgid, String uid, String message ) ``` 收到房间外用户调用 [sendUserMessageOutsideRoom](70080#RTCEngine-sendusermessageoutsideroom) 发来的文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号。 | | uid | String | 消息发送者 ID。 | | message | String | 收到的文本消息内容。 | ### onUserBinaryMessageReceivedOutsideRoom ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserBinaryMessageReceivedOutsideRoom( long msgid, String uid, ByteBuffer message ) ``` 收到房间外用户调用 [sendUserBinaryMessageOutsideRoom](70080#RTCEngine-senduserbinarymessageoutsideroom) 发来的二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号。 | | uid | String | 消息发送者 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onUserMessageSendResultOutsideRoom ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onUserMessageSendResultOutsideRoom( long msgid, int error ) ``` 给房间外指定的用户发送消息的结果回调。当调用 [sendUserMessageOutsideRoom](70080#RTCEngine-sendusermessageoutsideroom) 或 [sendUserBinaryMessageOutsideRoom](70080#RTCEngine-senduserbinarymessageoutsideroom) 发送消息后，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息 ID。
所有的 P2P 和 P2Server 消息共用一个 ID 序列。 | | error | int | 消息发送结果。详见 [UserMessageSendResult](70082#UserMessageSendResult)。 | ### onServerMessageSendResult ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onServerMessageSendResult( long msgid, int error, ByteBuffer message ) ``` 给应用服务器发送消息的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 本条消息的 ID
所有的 P2P 和 P2Server 消息共用一个 ID 序列。 | | error | int | 消息发送结果，详见 [UserMessageSendResult](70082#UserMessageSendResult)。 | | message | ByteBuffer | 应用服务器收到 HTTP 请求后，在 ACK 中返回的信息。消息不超过 64 KB。 | **注意** 本回调为异步回调。当调用 [sendServerMessage](70080#RTCEngine-sendservermessage) 或 [sendServerBinaryMessage](70080#RTCEngine-sendserverbinarymessage) 接口发送消息后，会收到此回调。 ### onNetworkDetectionResult ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onNetworkDetectionResult( NetworkDetectionLinkType type, int quality, int rtt, double lostRate, int bitrate, int jitter ) ``` 通话前网络探测结果。成功调用 [startNetworkDetection](70080#RTCEngine-startnetworkdetection) 接口开始探测后，会在 3s 内首次收到该回调，之后每 2s 收到一次该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | NetworkDetectionLinkType | 探测网络类型为上行/下行 | | quality | int | 探测网络的质量，参看 [NetworkQuality](70083#NetworkQuality)。 | | rtt | int | 探测网络的 RTT，单位：ms | | lostRate | double | 探测网络的丢包率 | | bitrate | int | 探测网络的带宽，单位：kbps | | jitter | int | 探测网络的抖动,单位：ms | ### onNetworkDetectionStopped ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onNetworkDetectionStopped(NetworkDetectionStopReason reason) ``` 通话前网络探测结束以下情况将停止探测并收到本一次本回调： 1. 当调用 [stopNetworkDetection](70080#RTCEngine-stopnetworkdetection) 接口停止探测后，会收到一次该回调； 2. 当收到远端/本端音频首帧后，停止探测； 3. 当探测超过 3 分钟后，停止探测； 4. 当探测链路断开一定时间之后，停止探测。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | reason | NetworkDetectionStopReason | 停止探测的原因类型,参考 [NetworkDetectionStopReason](70083#NetworkDetectionStopReason) | ### onAudioDeviceStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioDeviceStateChanged( String deviceID, AudioDeviceType deviceType, int deviceState, int deviceError ) ``` 音频设备状态回调。提示音频采集、音频播放等媒体设备的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | deviceID | String | 设备 ID | | deviceType | AudioDeviceType | 设备类型，详见 [AudioDeviceType](70083#AudioDeviceType)。 | | deviceState | int | 设备状态，详见 [MediaDeviceState](70083#MediaDeviceState)。 | | deviceError | int | 设备错误类型，详见 [MediaDeviceError](70083#MediaDeviceError)。 | ### onVideoDeviceStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onVideoDeviceStateChanged( String deviceID, VideoDeviceType deviceType, int deviceState, int deviceError ) ``` 视频设备状态回调。提示摄像头视频采集、屏幕视频采集等媒体设备的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | deviceID | String | 设备 ID | | deviceType | VideoDeviceType | 设备类型，详见 [VideoDeviceType](70083#VideoDeviceType)。 | | deviceState | int | 设备状态，详见 [MediaDeviceState](70083#MediaDeviceState)。 | | deviceError | int | 设备错误类型，详见 [MediaDeviceError](70083#MediaDeviceError)。 | ### onAudioDeviceWarning ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioDeviceWarning( String deviceID, AudioDeviceType deviceType, int deviceWarning ) ``` 音频设备警告回调。音频设备包括音频采集设备、音频渲染设备等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | deviceID | String | 设备 ID | | deviceType | AudioDeviceType | 参看 [AudioDeviceType](70083#AudioDeviceType) | | deviceWarning | int | 参看 [MediaDeviceWarning](70083#MediaDeviceWarning) | ### onVideoDeviceWarning ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onVideoDeviceWarning( String deviceID, VideoDeviceType deviceType, int deviceWarning ) ``` 视频设备警告回调，包括视频采集等设备。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | deviceID | String | 设备 ID | | deviceType | VideoDeviceType | 参看 [VideoDeviceType](70083#VideoDeviceType) | | deviceWarning | int | 参看 [MediaDeviceWarning](70083#MediaDeviceWarning) | ### onRecordingStateUpdate ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRecordingStateUpdate( IVideoSource videoSource, RecordingState state, RecordingErrorCode errorCode, RecordingInfo info ) ``` 获取本地录制状态回调。该回调由 [startFileRecording](70080#RTCEngine-startfilerecording) 或 [stopFileRecording](70080#RTCEngine-stopfilerecording) 触发。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数。 | | state | RecordingState | 录制状态，参看 [RecordingState](70083#RecordingState) | | errorCode | RecordingErrorCode | 录制错误码，参看 [RecordingErrorCode](70083#RecordingErrorCode) | | info | RecordingInfo | 录制文件的详细信息，参看 [RecordingInfo](70083#RecordingInfo) | ### onRecordingProgressUpdate ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRecordingProgressUpdate( IVideoSource videoSource, RecordingProgress progress, RecordingInfo info ) ``` 本地录制进度回调。该回调由 [startFileRecording](70080#RTCEngine-startfilerecording) 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数。 | | progress | RecordingProgress | 录制进度，参看 [RecordingProgress](70083#RecordingProgress) | | info | RecordingInfo | 录制文件的详细信息，参看 [RecordingInfo](70083#RecordingInfo) | ### onAudioRecordingStateUpdate ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioRecordingStateUpdate( AudioRecordingState state, AudioRecordingErrorCode errorCode ) ``` 调用 [startAudioRecording](70080#RTCEngine-startaudiorecording) 或 [stopAudioRecording](70080#RTCEngine-stopaudiorecording) 改变音频文件录制状态时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | AudioRecordingState | 录制状态，参看 [AudioRecordingState](70083#AudioRecordingState) | | errorCode | AudioRecordingErrorCode | 录制错误码，参看 [AudioRecordingErrorCode](70082#AudioRecordingErrorCode) | ### onAudioMixingPlayingProgress ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioMixingPlayingProgress( int mixId, long progress ) ``` 混音音频文件播放进度回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mixId | int | 混音 ID | | progress | long | 当前混音音频文件播放进度，单位毫秒 | **注意** 调用 setAudioMixingProgressInterval 将时间间隔设为大于 0 的值后，或调用 startAudioMixing 将 AudioMixingConfig 中的时间间隔设为大于 0 的值后，SDK 会按照设置的时间间隔回调该事件。 ### onLocalAudioPropertiesReport ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLocalAudioPropertiesReport(LocalAudioPropertiesInfo[] audioPropertiesInfos) ``` 调用 [enableAudioPropertiesReport](70080#RTCEngine-enableaudiopropertiesreport) 后，你会周期性地收到此回调，了解本地音频的瞬时相关信息。本地音频包括使用 RTC SDK 内部机制采集的麦克风音频，屏幕音频和本地混音音频信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioPropertiesInfos | LocalAudioPropertiesInfo [] | 本地音频信息，详见 [LocalAudioPropertiesInfo](70083#LocalAudioPropertiesInfo) 。 | ### onAudioPlaybackDeviceTestVolume ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioPlaybackDeviceTestVolume(int volume) ``` 回调音频设备测试时的播放音量 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | volume | int | 音频设备测试播放音量。取值范围：[0,255] | **注意** 调用 [startAudioPlaybackDeviceTest](70080#IRTCAudioDeviceManager-startaudioplaybackdevicetest) 或 [startAudioDeviceRecordTest](70080#IRTCAudioDeviceManager-startaudiodevicerecordtest)，开始播放音频文件或录音时，将开启该回调。本回调为周期性回调，回调周期由上述接口的 `interval` 参数指定。 ### onRemoteAudioPropertiesReport ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRemoteAudioPropertiesReport( RemoteAudioPropertiesInfo[] audioPropertiesInfos, int totalRemoteVolume ) ``` 远端用户进房后，本地调用 [enableAudioPropertiesReport](70080#RTCEngine-enableaudiopropertiesreport) ，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的瞬时音频信息。远端用户的音频包括使用 RTC SDK 内部机制/自定义机制采集的麦克风音频和屏幕音频。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioPropertiesInfos | RemoteAudioPropertiesInfo [] | 远端音频信息，其中包含音频流属性、房间 ID、用户 ID ，详见 [RemoteAudioPropertiesInfo](70083#RemoteAudioPropertiesInfo)。 | | totalRemoteVolume | int | 所有订阅的远端流混音后的音量，范围是 [0,255]。

[0,25] 接近无声；
[25,75] 为低音量；
[76,204] 为中音量；
[205,255] 为高音量。

| ### onActiveSpeaker ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onActiveSpeaker( String roomId, String uid ) ``` 调用 [enableAudioPropertiesReport](70080#RTCEngine-enableaudiopropertiesreport) 后，根据设置的 `AudioPropertiesConfig.interval`，你会周期性地收到此回调，获取房间内的最活跃用户信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID | | uid | String | 最活跃用户（ActiveSpeaker）的用户 ID | ### onEchoTestResult ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onEchoTestResult(EchoTestResult result) ``` 关于音视频回路测试结果的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | result | EchoTestResult | 测试结果，参看 [EchoTestResult](70083#EchoTestResult) | **注意** 该回调触发的时机包括： - 检测过程中采集设备发生错误时； - 检测成功后； - 非设备原因导致检测过程中未接收到音/视频回放，停止检测后。 ### onCloudProxyConnected ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onCloudProxyConnected(int interval) ``` 调用 [startCloudProxy](70080#RTCEngine-startcloudproxy) 开启云代理，SDK 首次成功连接云代理服务器时，回调此事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | interval | int | 从开启云代理到连接成功经过的时间，单位为 ms | ### onNetworkTimeSynchronized ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onNetworkTimeSynchronized() ``` 首次调用 [getNetworkTimeInfo](70080#RTCEngine-getnetworktimeinfo) 后，SDK 内部启动网络时间同步，同步完成时会触发此回调。 ### onHardwareEchoDetectionResult ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onHardwareEchoDetectionResult(HardwareEchoDetectionResult hardwareEchoDetectionResult) ``` 通话前回声检测结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | hardwareEchoDetectionResult | HardwareEchoDetectionResult | 参见 [HardwareEchoDetectionResult](70083#HardwareEchoDetectionResult) | **注意** - 通话前调用 [startHardwareEchoDetection](70080#RTCEngine-starthardwareechodetection) 后，将触发本回调返回检测结果。 - 建议在收到检测结果后，调用 [stopHardwareEchoDetection](70080#RTCEngine-stophardwareechodetection) 停止检测，释放对音频设备的占用。 - 如果 SDK 在通话中检测到回声，将通过 [onAudioDeviceWarning](#IRTCEngineEventHandler-onaudiodevicewarning) 回调 `MEDIA_DEVICE_WARNING_DETECT_LEAK_ECHO`。 ### onLocalProxyStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLocalProxyStateChanged( LocalProxyType localProxyType, LocalProxyState localProxyState, LocalProxyError localProxyError ) ``` 本地代理状态发生改变回调。调用 [setLocalProxy](70080#RTCEngine-setlocalproxy) 设置本地代理后，SDK 会触发此回调，通知代理连接的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | localProxyType | LocalProxyType | 本地代理类型。参看 [LocalProxyType](70083#LocalProxyType) 。 | | localProxyState | LocalProxyState | 本地代理状态。参看 [LocalProxyState](70083#LocalProxyState)。 | | localProxyError | LocalProxyError | 本地代理错误。参看 [LocalProxyError](70083#LocalProxyError)。 | ### onStreamSyncInfoReceived ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onStreamSyncInfoReceived( String streamId, StreamInfo streamInfo, StreamSyncInfoConfig.SyncInfoStreamType streamType, ByteBuffer data ) ``` 音频流同步信息回调。可以通过此回调，在远端用户调用 [sendStreamSyncInfo](70080#RTCEngine-sendstreamsyncinfo) 发送音频流同步消息后，收到远端发送的音频流同步信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID | | streamInfo | StreamInfo | 远端流信息，详见 [StreamInfo](70083#StreamInfo) | | streamType | StreamSyncInfoConfig.SyncInfoStreamType | 媒体流类型，详见 [SyncInfoStreamType](70083#SyncInfoStreamType) | | data | ByteBuffer | 消息内容。 | ### onRemoteSnapshotTakenToFile ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onRemoteSnapshotTakenToFile( String streamId, StreamInfo streamInfo, String filePath, int width, int height, SnapshotErrorCode errorCode, long taskId ) ``` > Available since 3.60. 调用 [takeRemoteSnapshotToFile](70080#RTCEngine-takeremotesnapshottofile) 截取视频画面时，会收到此回调报告截图是否成功，以及截取的图片信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 被截图的视频流 ID。 | | streamInfo | StreamInfo | 被截图的视频流信息，参看 [StreamInfo](70083#StreamInfo)。 | | filePath | String | 截图文件的保存路径。 | | width | int | 截图图像的宽度。单位：像素。 | | height | int | 截图图像的高度。单位：像素。 | | errorCode | SnapshotErrorCode | 截图错误码。参看 [SnapshotErrorCode](70083#SnapshotErrorCode)。 | | taskId | long | 截图任务的编号。和 [takeRemoteSnapshotToFile](70080#RTCEngine-takeremotesnapshottofile) 的返回值一致。 | ### onLocalSnapshotTakenToFile ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onLocalSnapshotTakenToFile( IVideoSource videoSource, String filePath, int width, int height, SnapshotErrorCode errorCode, long taskId ) ``` > Available since 3.60. 调用 [takeLocalSnapshotToFile](70080#RTCEngine-takelocalsnapshottofile) 截取视频画面时，会收到此回调报告截图是否成功，以及截取的图片信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数。 | | filePath | String | 截图文件的保存路径。 | | width | int | 截图图像的宽度。单位：像素。 | | height | int | 截图图像的高度。单位：像素。 | | errorCode | SnapshotErrorCode | 截图错误码。参看 [SnapshotErrorCode](70083#SnapshotErrorCode)。 | | taskId | long | 截图任务的编号。和 [takeLocalSnapshotToFile](70080#RTCEngine-takelocalsnapshottofile) 的返回值一致。 | ### onAudioFrameSendStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioFrameSendStateChanged( String streamId, StreamInfo streamInfo, RtcUser user, FirstFrameSendState state ) ``` 本地音频首帧发送状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，参看 [StreamInfo](70083#StreamInfo) | | user | RtcUser | 用户信息，参看 [RtcUser](70083#RtcUser) | | state | FirstFrameSendState | 首帧发送状态，详见 [FirstFrameSendState](70083#FirstFrameSendState) | ### onVideoFrameSendStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onVideoFrameSendStateChanged( String streamId, StreamInfo streamInfo, RtcUser user, FirstFrameSendState state ) ``` 视频首帧发送状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，参看 [StreamInfo](70083#StreamInfo) | | user | RtcUser | 用户信息，参看 [RtcUser](70083#RtcUser) | | state | FirstFrameSendState | 首帧发送状态，详见 [FirstFrameSendState](70083#FirstFrameSendState) | ### onAudioFramePlayStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onAudioFramePlayStateChanged( String streamId, StreamInfo streamInfo, RtcUser user, FirstFramePlayState state ) ``` 音频首帧播放状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，参看 [StreamInfo](70083#StreamInfo) | | user | RtcUser | 用户信息，参看 [RtcUser](70083#RtcUser) | | state | FirstFramePlayState | 首帧播放状态，详见 [FirstFramePlayState](70083#FirstFramePlayState) | ### onVideoFramePlayStateChanged ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onVideoFramePlayStateChanged( String streamId, StreamInfo streamInfo, RtcUser user, FirstFramePlayState state ) ``` 远端视频流的首帧播放状态改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，参看 [StreamInfo](70083#StreamInfo) | | user | RtcUser | 用户信息，参看 [RtcUser](70083#RtcUser) | | state | FirstFramePlayState | 首帧播放状态，详见 [FirstFramePlayState](70083#FirstFramePlayState) | ### onSimulcastSubscribeFallback ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onSimulcastSubscribeFallback( String streamId, StreamInfo streamInfo, RemoteStreamSwitch event ) ``` 音视频流因网络环境变化等原因发生回退，或从回退中恢复时，触发该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，参看 [StreamInfo](70083#StreamInfo) | | event | RemoteStreamSwitch | 音视频流发生变化的信息。参看 [RemoteStreamSwitch](70083#RemoteStreamSwitch)。 | ### onPerformanceAlarms ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onPerformanceAlarms( String streamId, StreamInfo streamInfo, PerformanceAlarmMode mode, PerformanceAlarmReason reason, SourceWantedData data ) ``` 本地未通过 [setPublishFallbackOption](70080#RTCEngine-setpublishfallbackoption) 开启发布性能回退，检测到设备性能不足时，收到此回调。本地通过 [setPublishFallbackOption](70080#RTCEngine-setpublishfallbackoption) 开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 流 ID | | streamInfo | StreamInfo | 流信息，参看 [StreamInfo](70083#StreamInfo) | | mode | PerformanceAlarmMode | 指示本地是否开启发布回退功能。参看 [PerformanceAlarmMode](70083#PerformanceAlarmMode)

当发布端未开启发布性能回退时，mode 值为 NORMAL。
当发布端开启发布性能回退时，mode 值为 SIMULCAST。

| | reason | PerformanceAlarmReason | 告警原因，参看 [PerformanceAlarmReason](70083#PerformanceAlarmReason) | | data | SourceWantedData | 性能回退相关数据，详见 [SourceWantedData](70083#SourceWantedData)。 | ### onMixedStreamEvent ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onMixedStreamEvent( MixedStreamTaskInfo info, MixedStreamTaskEvent event, MixedStreamTaskErrorCode error ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onStreamMixingEvent` 和 `onPushPublicStreamResult` 方法来实现下述功能。如果你已升级至 3.60 及以上版本，并且仍在使用这两个方法，请迁移到此回调。合流转推 CDN / WTN 流状态回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | info | MixedStreamTaskInfo | 任务详情，参看 [MixedStreamTaskInfo](70083#MixedStreamTaskInfo)。 | | event | MixedStreamTaskEvent | 任务事件，参看 [MixedStreamTaskEvent](70083#MixedStreamTaskEvent)。 | | error | MixedStreamTaskErrorCode | 任务错误码，参看 [MixedStreamTaskErrorCode](70082#MixedStreamTaskErrorCode) | ### onSingleStreamEvent ```java public void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onSingleStreamEvent( String taskId, SingleStreamTaskEvent event, SingleStreamTaskErrorCode error ) ``` > Available since 3.60. 单流转推 CDN 状态回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | taskId | String | 任务 ID | | event | SingleStreamTaskEvent | 任务状态, 参看 [SingleStreamTaskEvent](70082#SingleStreamTaskEvent) | | error | SingleStreamTaskErrorCode | 错误码，参看 [SingleStreamTaskErrorCode](70082#SingleStreamTaskErrorCode) | ### onPushPublicStreamResult ```java void com.ss.bytertc.engine.handler.IRTCEngineEventHandler.onPushPublicStreamResult( String roomId, String publicStreamId, PublicStreamErrorCode error ) ``` > Deprecated since 3.60, use [onMixedStreamEvent](#IRTCEngineEventHandler-onmixedstreamevent) instead. WTN 流发布结果回调。调用 [startPushMixedStream](70080#RTCEngine-startpushmixedstream) 接口发布WTN 流后，启动结果通过此回调方法通知用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 发布WTN 流的房间 ID | | publicStreamId | String | WTN 流 ID | | error | PublicStreamErrorCode | WTN 流发布结果状态码。详见 [PublicStreamErrorCode](70082#PublicStreamErrorCode)。 | # IRemoteEncodedVideoFrameObserver ```java public abstract class com.ss.bytertc.engine.mediaio.IRemoteEncodedVideoFrameObserver ``` 远端编码后视频数据监测器注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | abstract void | [onRemoteEncodedVideoFrame](#IRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe) | ## 函数说明 ### onRemoteEncodedVideoFrame ```java public abstract void com.ss.bytertc.engine.mediaio.IRemoteEncodedVideoFrameObserver.onRemoteEncodedVideoFrame( String streamId, StreamInfo streamInfo, RTCEncodedVideoFrame encodedVideoFrame ) ``` 调用 [registerRemoteEncodedVideoFrameObserver](70080#RTCEngine-registerremoteencodedvideoframeobserver) 后，SDK 监测到远端编码后视频数据时，触发该回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 收到的远端流 ID | | streamInfo | StreamInfo | 收到的远端流信息，参看 [StreamInfo](70083#StreamInfo) | | encodedVideoFrame | RTCEncodedVideoFrame | 收到的远端视频帧信息，参看 [RTCEncodedVideoFrame](70083#RTCEncodedVideoFrame) | **注意** encodedVideoFrame 只在回调函数作用域内有效，不要存储该参数并在其它函数内访问该参数的内存数据 # IFaceDetectionObserver ```java public interface com.ss.bytertc.engine.video.IFaceDetectionObserver ``` 人脸检测结果回调观察者注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onFaceDetectResult](#IFaceDetectionObserver-onfacedetectresult) | ## 函数说明 ### onFaceDetectResult ```java void com.ss.bytertc.engine.video.IFaceDetectionObserver.onFaceDetectResult(FaceDetectionResult result) ``` 特效 SDK 进行人脸检测结果的回调。调用 [enableFaceDetection](70080#IVideoEffect-enablefacedetection) 注册了 [IFaceDetectionObserver](#IFaceDetectionObserver)，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | result | FaceDetectionResult | 人脸检测结果, 参看 [FaceDetectionResult](70083#FaceDetectionResult)。 | # IWTNStreamEventHandler ```java public interface com.ss.bytertc.engine.IWTNStreamEventHandler ``` WTN 事件回调接口。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onWTNRemoteVideoStats](#IWTNStreamEventHandler-onwtnremotevideostats) | | void | [onWTNRemoteAudioStats](#IWTNStreamEventHandler-onwtnremoteaudiostats) | | void | [onWTNVideoSubscribeStateChanged](#IWTNStreamEventHandler-onwtnvideosubscribestatechanged) | | void | [onWTNAudioSubscribeStateChanged](#IWTNStreamEventHandler-onwtnaudiosubscribestatechanged) | | void | [onWTNFirstRemoteAudioFrame](#IWTNStreamEventHandler-onwtnfirstremoteaudioframe) | | void | [onWTNFirstRemoteVideoFrameDecoded](#IWTNStreamEventHandler-onwtnfirstremotevideoframedecoded) | | void | [onWTNSEIMessageReceived](#IWTNStreamEventHandler-onwtnseimessagereceived) | | void | [onWTNDataMessageReceived](#IWTNStreamEventHandler-onwtndatamessagereceived) | ## 函数说明 ### onWTNRemoteVideoStats ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNRemoteVideoStats( String streamId, RemoteVideoStats stats ) ``` > Available since 3.60. 通话中本地设备接收订阅的远端 WTN 视频流的流 ID 以及远端 WTN 视频流统计信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 流 ID | | stats | RemoteVideoStats | 远端 WTN 视频流的统计信息，详见 [RemoteVideoStats](70083#RemoteVideoStats)。 | ### onWTNRemoteAudioStats ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNRemoteAudioStats( String streamId, RemoteAudioStats stats ) ``` > Available since 3.60. 通话中本地设备接收订阅的远端 WTN 音频流的流 ID 以及远端 WTN 音频流统计信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 流 ID | | stats | RemoteAudioStats | 远端 WTN 音频流的统计信息，详见 [RemoteAudioStats](70083#RemoteAudioStats)。 | ### onWTNVideoSubscribeStateChanged ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNVideoSubscribeStateChanged( String streamId, WTNSubscribeState stateCode, WTNSubscribeStateChangeReason reason ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onPlayPublicStreamResult` 方法中的 WTN 视频流订阅状态变化通知功能。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此回调。 WTN 视频流订阅状态变化回调通过 [subscribeWTNVideoStream](70080#IWTNStream-subscribewtnvideostream) 订阅 WTN 视频流后，可以通过本回调获取订阅结果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 视频流的 ID | | stateCode | WTNSubscribeState | 视频流状态码，参看 [WTNSubscribeState](70083#WTNSubscribeState)。 | | reason | WTNSubscribeStateChangeReason | 订阅状态发生变化的原因，参看 [WTNSubscribeStateChangeReason](70083#WTNSubscribeStateChangeReason)。 | ### onWTNAudioSubscribeStateChanged ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNAudioSubscribeStateChanged( String streamId, WTNSubscribeState stateCode, WTNSubscribeStateChangeReason reason ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onPlayPublicStreamResult` 方法中的 WTN 音频流订阅状态变化通知功能。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此回调。 WTN 音频流订阅状态变化回调通过 [subscribeWTNAudioStream](70080#IWTNStream-subscribewtnaudiostream) 订阅 WTN 音频流后，可以通过本回调获取订阅结果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 音频流的 ID | | stateCode | WTNSubscribeState | 音频流状态码，参看 [WTNSubscribeState](70083#WTNSubscribeState)。 | | reason | WTNSubscribeStateChangeReason | 订阅状态发生变化的原因. See [WTNSubscribeStateChangeReason](70083#WTNSubscribeStateChangeReason). | ### onWTNFirstRemoteAudioFrame ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNFirstRemoteAudioFrame(String streamId) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onFirstPublicStreamAudioFrame`。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此回调。 WTN 流的首帧音频解码成功关于订阅 WTN 音频流，详见 [subscribeWTNAudioStream](70080#IWTNStream-subscribewtnaudiostream)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 流 ID | ### onWTNFirstRemoteVideoFrameDecoded ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNFirstRemoteVideoFrameDecoded( String streamId, VideoFrameInfo info ) ``` > Available since 3.60. 自 3.60 起，该回调替代了 `onFirstPublicStreamVideoFrameDecoded`。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此回调。 WTN 流的首帧视频解码成功关于订阅 WTN 流，详见 [subscribeWTNVideoStream](70080#IWTNStream-subscribewtnvideostream)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 流 ID | | info | VideoFrameInfo | 视频帧信息。详见 [VideoFrameInfo](70083#VideoFrameInfo)。 | ### onWTNSEIMessageReceived ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNSEIMessageReceived( String streamId, int channelId, ByteBuffer message ) ``` > Available since 3.60. 自 3.60 起，该回调替换了 `onPublicStreamSEIMessageReceived` 来实现下述功能。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此回调。回调 WTN 流中包含的 SEI 信息。调用 [subscribeWTNAudioStream](70080#IWTNStream-subscribewtnaudiostream)/[subscribeWTNVideoStream](70080#IWTNStream-subscribewtnvideostream)接口拉 WTN 音频流/视频流后，通过此回调收到 WTN 流中的 SEI 消息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 流 ID。 | | channelId | int | SEI 的消息传输通道，取值范围 `[0 - 255]`。通过此参数，你可以为不同接受方设置不同的 ChannelID，这样不同接收方可以根据回调中的 ChannelID 选择应关注的 SEI 信息。 | | message | ByteBuffer | 收到的 SEI 消息内容。
通过调用客户端 `sendSEIMessage` 插入的 SEI 信息。
当 WTN 流中的多路视频流均包含有 SEI 信息：SEI 不互相冲突时，将通过多次回调分别发送；SEI 在同一帧有冲突时，则只有一条流中的 SEI 信息被透传并融合到 WTN 流中。 | ### onWTNDataMessageReceived ```java void com.ss.bytertc.engine.IWTNStreamEventHandler.onWTNDataMessageReceived( String streamId, ByteBuffer message, DataMessageSourceType sourceType ) ``` > Available since 3.60. 回调 WTN 流中包含的数据信息。通过 [subscribeWTNAudioStream](70080#IWTNStream-subscribewtnaudiostream)/[subscribeWTNVideoStream](70080#IWTNStream-subscribewtnvideostream) 订阅 WTN 流后，通过监听本回调获取 WTN 流中的数据消息，包括调用 Open API 发送的 SEI 消息和音量回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | WTN 流 ID | | message | ByteBuffer | 收到的数据消息内容，如下：

调用 WTN 流 OpenAPI 发送的自定义消息。
媒体流音量变化，需要通过 WTN 流 OpenAPI 开启回调。JSON 格式说明如下：
{
"Type" ："VolumeIndication", //具体业务类型
"VolumeInfos" ：[ // 业务类型对应信息
{
"RoomId":"1000001", // 房间 ID
"UserId":"1000001", // 用户 ID
"StreamType":0, // 0:摄像头流；1:屏幕流
"LinearVolume":1 // 线性音量大小
}

| | sourceType | DataMessageSourceType | 数据消息来源，参看 [DataMessageSourceType](70083#DataMessageSourceType)。 | **注意** 通过调用客户端 API 插入的 SEI 信息，应通过回调 [onWTNSEIMessageReceived](#IWTNStreamEventHandler-onwtnseimessagereceived) 获取。 # IMediaPlayerAudioFrameObserver ```java public interface com.ss.bytertc.engine.IMediaPlayerAudioFrameObserver ``` 本地音频文件混音的音频帧观察者。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onFrame](#IMediaPlayerAudioFrameObserver-onframe) | ## 函数说明 ### onFrame ```java void com.ss.bytertc.engine.IMediaPlayerAudioFrameObserver.onFrame( int playerId, IAudioFrame frame ) ``` 当本地音频文件混音时，回调播放的音频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | playerId | int | 播放器 ID | | frame | IAudioFrame | 参看 [IAudioFrame](70083#IAudioFrame)。 | # IAudioFileFrameObserver ```java public interface com.ss.bytertc.engine.IAudioFileFrameObserver ``` 本地音频文件混音的音频帧观察者。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onAudioFileFrame](#IAudioFileFrameObserver-onaudiofileframe) | ## 函数说明 ### onAudioFileFrame ```java void com.ss.bytertc.engine.IAudioFileFrameObserver.onAudioFileFrame( int mixID, IAudioFrame audioFrame ) ``` 当本地音频文件混音时，回调播放的音频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mixID | int | 混音 ID。 | | audioFrame | IAudioFrame | 参看 [IAudioFrame](70083#IAudioFrame)。 | # IRTSRoomEventHandler ```java public abstract class com.ss.bytertc.engine.handler.IRTSRoomEventHandler ``` IRTSRoomEventHandler Class 注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onLeaveRoom](#IRTSRoomEventHandler-onleaveroom) | | void | [onRoomStateChanged](#IRTSRoomEventHandler-onroomstatechanged) | | void | [onUserJoined](#IRTSRoomEventHandler-onuserjoined) | | void | [onUserLeave](#IRTSRoomEventHandler-onuserleave) | | void | [onRoomMessageReceived](#IRTSRoomEventHandler-onroommessagereceived) | | void | [onRoomBinaryMessageReceived](#IRTSRoomEventHandler-onroombinarymessagereceived) | | void | [onUserMessageReceived](#IRTSRoomEventHandler-onusermessagereceived) | | void | [onUserBinaryMessageReceived](#IRTSRoomEventHandler-onuserbinarymessagereceived) | | void | [onRoomMessageReceived](#IRTSRoomEventHandler-onroommessagereceived-2) | | void | [onRoomBinaryMessageReceived](#IRTSRoomEventHandler-onroombinarymessagereceived-2) | | void | [onUserMessageReceived](#IRTSRoomEventHandler-onusermessagereceived-2) | | void | [onUserBinaryMessageReceived](#IRTSRoomEventHandler-onuserbinarymessagereceived-2) | | void | [onUserMessageSendResult](#IRTSRoomEventHandler-onusermessagesendresult) | | void | [onRoomMessageSendResult](#IRTSRoomEventHandler-onroommessagesendresult) | ## 函数说明 ### onLeaveRoom ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onLeaveRoom(RTCRoomStats stats) ``` 离开房间成功回调。用户调用 [leaveRoom](70080#RTSRoom-leaveroom) 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | RTCRoomStats | 保留参数，目前为空。 | **注意** - 用户调用 [leaveRoom](70080#RTSRoom-leaveroom) 方法离开房间后，如果立即调用 [destroy](70080#RTSRoom-destroy) 销毁房间实例或 [destroyRTCEngine](70080#RTCEngine-destroyrtcengine) 方法销毁 RTC 引擎，则将无法收到此回调事件。 - 离开房间后，如果 App 需要使用系统音视频设备，则建议在收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备导致初始化失败。 ### onRoomStateChanged ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onRoomStateChanged( String roomId, String uid, int state, String extraInfo ) ``` 房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomId | String | 房间 ID。 | | uid | String | 用户 ID。 | | state | int | 房间状态码。

0：加入房间成功。
!0：加入房间失败、异常退房、发生房间相关的警告或错误。具体原因参看 [ErrorCode](70082#ErrorCode) 及 [WarningCode](70082#WarningCode)。

| | extraInfo | String | 额外信息，如 `{"elapsed":1187,"join_type":0}`。
`join_type` 表示加入房间的类型，`0`为首次进房，`1`为重连进房。
`elapsed` 表示加入房间耗时，即本地用户从调用 [joinRoom](70080#RTCRoom-joinroom) 到加入房间成功所经历的时间间隔，单位为 ms。 | ### onUserJoined ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserJoined(UserInfo userInfo) ``` 远端可见用户加入房间，或房内不可见用户切换为可见的回调。 1.远端用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。 2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。 3.房间内隐身远端用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 方法切换至可见时，房间内其他用户将收到该事件。 4.新进房用户也会收到进房前已在房内的可见用户的进房回调通知。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | userInfo | UserInfo | 用户信息。参看 [UserInfo](70083#UserInfo)。 | ### onUserLeave ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserLeave( String uid, int reason ) ``` 远端用户离开房间，或切至不可见时，房间内其他用户会收到此事件 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 离开房间，或切至不可见的的远端用户 ID。 | | reason | int | 用户离开房间的原因：

0：远端用户调用 [leaveRoom](70080#RTSRoom-leaveroom) 主动退出房间。
1：远端用户因 Token 过期或网络原因等掉线。详细信息请参看[连接状态提示](https://www.volcengine.com/docs/6348/95376)
2：远端用户调用 [setUserVisibility](70080#RTCRoom-setuservisibility) 切换至不可见状态。
3：服务端调用 OpenAPI 将该远端用户踢出房间。

| ### onRoomMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onRoomMessageReceived( String uid, String message ) ``` 接收到房间内广播消息的回调。房间内其他用户调用 [sendRoomMessage](70080#RTSRoom-sendroommessage) 发送广播消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者 ID | | message | String | 收到的消息内容 | ### onRoomBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onRoomBinaryMessageReceived( String uid, ByteBuffer message ) ``` 收到房间内广播二进制消息的回调。房间内其他用户调用 [sendRoomBinaryMessage](70080#RTSRoom-sendroombinarymessage) 发送广播二进制消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者 ID | | message | ByteBuffer | 收到的二进制消息内容 | ### onUserMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserMessageReceived( String uid, String message ) ``` 收到来自房间中其他用户通过 [sendUserMessage](70080#RTSRoom-sendusermessage) 发来的点对点文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者的用户 ID。 | | message | String | 收到的文本消息内容。 | ### onUserBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserBinaryMessageReceived( String uid, ByteBuffer message ) ``` 收到来自房间中其他用户通过 [sendUserBinaryMessage](70080#RTSRoom-senduserbinarymessage) 发来的点对点二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | String | 消息发送者的用户 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onRoomMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onRoomMessageReceived( long msgid, String uid, String message ) ``` 接收到房间内广播消息的回调。房间内其他用户调用 [sendRoomMessage](70080#RTSRoom-sendroommessage) 发送广播消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号 | | uid | String | 消息发送者 ID | | message | String | 收到的消息内容 | ### onRoomBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onRoomBinaryMessageReceived( long msgid, String uid, ByteBuffer message ) ``` 收到房间内广播二进制消息的回调。房间内其他用户调用 [sendRoomBinaryMessage](70080#RTSRoom-sendroombinarymessage) 发送广播二进制消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号 | | uid | String | 消息发送者 ID | | message | ByteBuffer | 收到的二进制消息内容 | ### onUserMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserMessageReceived( long msgid, String uid, String message ) ``` 收到来自房间中其他用户通过 [sendUserMessage](70080#RTSRoom-sendusermessage) 发来的点对点文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号 | | uid | String | 消息发送者的用户 ID。 | | message | String | 收到的文本消息内容。 | ### onUserBinaryMessageReceived ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserBinaryMessageReceived( long msgid, String uid, ByteBuffer message ) ``` 收到来自房间中其他用户通过 [sendUserBinaryMessage](70080#RTSRoom-senduserbinarymessage) 发来的点对点二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 消息编号 | | uid | String | 消息发送者的用户 ID。 | | message | ByteBuffer | 收到的二进制消息内容。 | ### onUserMessageSendResult ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onUserMessageSendResult( long msgid, int error ) ``` 向房间内单个用户发送文本或二进制消息后（P2P），消息发送方会收到该消息发送结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 本条消息的 ID。 | | error | int | 文本或二进制消息发送结果，详见 [UserMessageSendResult](70082#UserMessageSendResult) | **注意** 调用 [sendUserMessage](70080#RTSRoom-sendusermessage) 或 [sendUserBinaryMessage](70080#RTSRoom-senduserbinarymessage) 接口，才能收到此回调。 ### onRoomMessageSendResult ```java public void com.ss.bytertc.engine.handler.IRTSRoomEventHandler.onRoomMessageSendResult( long msgid, int error ) ``` 调用 [sendRoomMessage](70080#RTSRoom-sendroommessage) 或 [sendRoomBinaryMessage](70080#RTSRoom-sendroombinarymessage) 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | long | 本条消息的 ID。 | | error | int | 消息发送结果，详见 [RoomMessageSendResult](70082#RoomMessageSendResult) | # ILocalEncodedVideoFrameObserver ```java public interface com.ss.bytertc.engine.mediaio.ILocalEncodedVideoFrameObserver ``` 本地视频帧监测器注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onLocalEncodedVideoFrame](#ILocalEncodedVideoFrameObserver-onlocalencodedvideoframe) | ## 函数说明 ### onLocalEncodedVideoFrame ```java void com.ss.bytertc.engine.mediaio.ILocalEncodedVideoFrameObserver.onLocalEncodedVideoFrame( IVideoSource videoSource, RTCEncodedVideoFrame encodedVideoFrame ) ``` 调用 [registerLocalEncodedVideoFrameObserver](70080#RTCEngine-registerlocalencodedvideoframeobserver) 后，SDK 每次使用内部采集，采集到一帧视频帧，或收到一帧外部视频帧时，都会回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSource | IVideoSource | 预留参数 | | encodedVideoFrame | RTCEncodedVideoFrame | 本地视频帧信息，参看 [RTCEncodedVideoFrame](70083#RTCEncodedVideoFrame) | **注意** encodedVideoFrame 只在回调函数作用域内有效，不要存储该参数并在其它函数内访问该参数的内存数据 # IExternalVideoEncoderEventHandler ```java public abstract class com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler ``` 自定义编码帧回调类注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | abstract void | [onStart](#IExternalVideoEncoderEventHandler-onstart) | | abstract void | [onStop](#IExternalVideoEncoderEventHandler-onstop) | | abstract void | [onRateUpdate](#IExternalVideoEncoderEventHandler-onrateupdate) | | abstract void | [onRequestKeyFrame](#IExternalVideoEncoderEventHandler-onrequestkeyframe) | | abstract void | [onActiveVideoLayer](#IExternalVideoEncoderEventHandler-onactivevideolayer) | ## 函数说明 ### onStart ```java public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onStart( String streamId, StreamInfo streamInfo ) ``` 提示自定义编码帧可以开始推送的回调。收到该回调后，你即可调用 [pushExternalEncodedVideoFrame](70080#RTCEngine-pushexternalencodedvideoframe) 向 SDK 推送自定义编码视频帧 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 可以推送的编码流的 ID | | streamInfo | StreamInfo | 可以推送的编码流的属性 | ### onStop ```java public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onStop( String streamId, StreamInfo streamInfo ) ``` 当收到该回调时，你需停止向 SDK 推送自定义编码视频帧 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 需停止推送的编码流的 ID | | streamInfo | StreamInfo | 需停止推送的编码流的属性 | ### onRateUpdate ```java public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onRateUpdate( String streamId, StreamInfo streamInfo, int videoIndex, int fps, int bitrateKbps ) ``` 当自定义编码流的帧率或码率发生变化时，触发该回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 发生变化的编码流的 ID | | streamInfo | StreamInfo | 发生变化的编码流的属性 | | videoIndex | int | 对应编码流的下标 | | fps | int | 变化后的帧率，单位：fps | | bitrateKbps | int | 变化后的码率，单位：kbps | ### onRequestKeyFrame ```java public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onRequestKeyFrame( String streamId, StreamInfo streamInfo, int videoIndex ) ``` 提示流发布端需重新生成关键帧的回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端编码流的 ID | | streamInfo | StreamInfo | 远端编码流的属性 | | videoIndex | int | 对应编码流的下标 | ### onActiveVideoLayer ```java public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onActiveVideoLayer( String streamId, StreamInfo streamInfo, int videoIndex, boolean active ) ``` > Available since 3.56 作为自定义编码视频流的发送端，你会在视频流可发送状态发生变化时，收到此回调。你可以根据此回调的提示，仅对可发送的视频流进行编码，以降低本端视频编码性能消耗。此回调会根据多个因素综合判断触发，包括：本端设备性能和本端网络性能，以及按需订阅场景下，远端用户是否订阅。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 编码流的 ID | | streamInfo | StreamInfo | 编码流的属性 | | videoIndex | int | 对应编码流的下标 | | active | boolean | 该路流可发送状态 | **注意** 要收到此回调，必须调用 [setVideoSourceType](70080#RTCEngine-setvideosourcetype) 设置视频源是自定义编码，且通过 [setExternalVideoEncoderEventHandler](70080#RTCEngine-setexternalvideoencodereventhandler) 设置了回调句柄。 # IMediaPlayerEventHandler ```java public interface com.ss.bytertc.engine.IMediaPlayerEventHandler ``` [IMediaPlayer](70080#IMediaPlayer) 对应的回调句柄。你必须调用 [setEventHandler](70080#IMediaPlayer-seteventhandler) 完成设置后，才能收到对应回调。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onMediaPlayerStateChanged](#IMediaPlayerEventHandler-onmediaplayerstatechanged) | | void | [onMediaPlayerPlayingProgress](#IMediaPlayerEventHandler-onmediaplayerplayingprogress) | | void | [onMediaPlayerEvent](#IMediaPlayerEventHandler-onmediaplayerevent) | ## 函数说明 ### onMediaPlayerStateChanged ```java void com.ss.bytertc.engine.IMediaPlayerEventHandler.onMediaPlayerStateChanged( int playerId, PlayerState state, PlayerError error ) ``` 播放状态改变时回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | playerId | int | [IMediaPlayer](70080#IMediaPlayer) 的 ID。通过 [getMediaPlayer](70080#RTCEngine-getmediaplayer) 设置。 | | state | PlayerState | 混音状态。参考 [PlayerState](70083#PlayerState)。 | | error | PlayerError | 错误码。参考 [PlayerError](70083#PlayerError)。 | ### onMediaPlayerPlayingProgress ```java void com.ss.bytertc.engine.IMediaPlayerEventHandler.onMediaPlayerPlayingProgress( int playerId, long progress ) ``` 播放进度周期性回调。回调周期通过 [setProgressInterval](70080#IMediaPlayer-setprogressinterval) 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | playerId | int | [IMediaPlayer](70080#IMediaPlayer) 的 ID。通过 [getMediaPlayer](70080#RTCEngine-getmediaplayer) 设置。 | | progress | long | 进度。单位 ms。 | ### onMediaPlayerEvent ```java void com.ss.bytertc.engine.IMediaPlayerEventHandler.onMediaPlayerEvent( int playerId, PlayerEvent event, String message ) ``` > Available since 3.59 播放事件回调。调用 [selectAudioTrack](70080#IMediaPlayer-selectaudiotrack) 和 [setPosition](70080#IMediaPlayer-setposition) 后，会触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | playerId | int | [IMediaPlayer](70080#IMediaPlayer) 的 ID。通过 [getMediaPlayer](70080#RTCEngine-getmediaplayer) 设置。 | | event | PlayerEvent | 播放器事件。参看 [PlayerEvent](70083#PlayerEvent)。 | | message | String | 事件描述信息，可能为空。 | # IAudioFrameObserver ```java public interface com.ss.bytertc.engine.IAudioFrameObserver ``` 音频数据回调观察者注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。本接口类中的回调周期均为 20 ms。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onRecordAudioFrame](#IAudioFrameObserver-onrecordaudioframe) | | void | [onPlaybackAudioFrame](#IAudioFrameObserver-onplaybackaudioframe) | | void | [onRemoteUserAudioFrame](#IAudioFrameObserver-onremoteuseraudioframe) | | void | [onMixedAudioFrame](#IAudioFrameObserver-onmixedaudioframe) | | void | [onCaptureMixedAudioFrame](#IAudioFrameObserver-oncapturemixedaudioframe) | ## 函数说明 ### onRecordAudioFrame ```java void com.ss.bytertc.engine.IAudioFrameObserver.onRecordAudioFrame(IAudioFrame audioFrame) ``` 返回麦克风录制的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频数据, 参看 [IAudioFrame](70083#IAudioFrame)。 | ### onPlaybackAudioFrame ```java void com.ss.bytertc.engine.IAudioFrameObserver.onPlaybackAudioFrame(IAudioFrame audioFrame) ``` 返回订阅的所有远端用户混音后的音频数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频数据, 参看 [IAudioFrame](70083#IAudioFrame)。 | ### onRemoteUserAudioFrame ```java void com.ss.bytertc.engine.IAudioFrameObserver.onRemoteUserAudioFrame( String streamId, StreamInfo streamInfo, IAudioFrame audioFrame ) ``` 返回远端单个用户的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID。 | | streamInfo | StreamInfo | 远端流信息，参看 [StreamInfo](70083#StreamInfo)。 | | audioFrame | IAudioFrame | 音频数据，参看 [IAudioFrame](70083#IAudioFrame)。 | **注意** 此回调在播放线程调用。不要在此回调中做任何耗时的事情，否则可能会影响整个音频播放链路。 ### onMixedAudioFrame ```java void com.ss.bytertc.engine.IAudioFrameObserver.onMixedAudioFrame(IAudioFrame audioFrame) ``` 返回本地麦克风录制和订阅的所有远端用户混音后的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频数据, 参看 [IAudioFrame](70083#IAudioFrame)。 | ### onCaptureMixedAudioFrame ```java void com.ss.bytertc.engine.IAudioFrameObserver.onCaptureMixedAudioFrame(IAudioFrame audioFrame) ``` 返回本地麦克风录制的音频数据，本地 `MediaPlayer` / `EffectPlayer` 播放音频文件混音后的音频数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频数据, 参看 [IAudioFrame](70083#IAudioFrame)。 | # IRTCEncryptionHandler ```java public interface com.ss.bytertc.engine.handler.IRTCEncryptionHandler ``` 加密事件回调接口注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | byte[] | [onEncryptData](#IRTCEncryptionHandler-onencryptdata) | | byte[] | [onDecryptData](#IRTCEncryptionHandler-ondecryptdata) | ## 函数说明 ### onEncryptData ```java byte[] com.ss.bytertc.engine.handler.IRTCEncryptionHandler.onEncryptData(byte[] data) ``` 自定义加密。使用设定的自定义加密方式，对编码后传输前的音视频帧数据进行加密。暂不支持对原始音视频帧进行加密。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | byte[] | 未加密的数据。 | **返回值** 加密后的数据 ### onDecryptData ```java byte[] com.ss.bytertc.engine.handler.IRTCEncryptionHandler.onDecryptData(byte[] data) ``` 自定义解密。对自定义加密后的音视频帧数据进行解密。关于自定义加密，参看 [onEncryptData](#IRTCEncryptionHandler-onencryptdata)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | byte[] | 加密过的数据。 | **返回值** 解密后的数据 # IMediaPlayerCustomSourceProvider ```java public interface com.ss.bytertc.engine.IMediaPlayerCustomSourceProvider ``` 内存播放数据源回调 ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [onReadData](#IMediaPlayerCustomSourceProvider-onreaddata) | | long | [onSeek](#IMediaPlayerCustomSourceProvider-onseek) | ## 函数说明 ### onReadData ```java int com.ss.bytertc.engine.IMediaPlayerCustomSourceProvider.onReadData( ByteBuffer buffer, int bufferSize ) ``` > Available since 3.53 调用 [openWithCustomSource](70080#IMediaPlayer-openwithcustomsource) 接口播放用户传入的内存音频数据时，会触发此回调，用户需要写入音频数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | buffer | ByteBuffer | 内存地址。在该地址中写入音频数据，写入音频数据的大小不超过 bufferSize 中填入的数值。支持的音频数据格式有：mp3，aac，m4a，3gp，wav。 | | bufferSize | int | 音频数据大小，单位为字节。如果你想停止播放内存音频数据，可在 bufferSize 中填入小于或等于 0 的数，此时 SDK 会停止调用此接口。 | **返回值** 返回实际读取的音频数据大小。 **注意** 若 [openWithCustomSource](70080#IMediaPlayer-openwithcustomsource) 接口调用失败，请在 buffer 和 bufferSize 两个参数中填入 0。此时 SDK 会停止调用此接口。 ### onSeek ```java long com.ss.bytertc.engine.IMediaPlayerCustomSourceProvider.onSeek( long offset, MediaPlayerCustomSourceSeekWhence whence ) ``` > Available since 3.53 根据设置好的内存音频数据的读取位置和读取偏移量对音频数据进行偏移，以便 SDK 读取和分析音频数据。在调用 [openWithCustomSource](70080#IMediaPlayer-openwithcustomsource) 接口传入内存音频数据，或者调用 [setPosition](70080#IMediaPlayer-setposition) 设置了音频数据的起始播放位置后，SDK 会对音频数据进行读取和分析，此时会触发该回调，你需要根据参数中设置的起始读取位置和偏移量进行操作。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | offset | long | 音频数据读取偏移量，单位为字节，取值可正可负。 | | whence | MediaPlayerCustomSourceSeekWhence | 音频数据的起始读取位置。参看 [MediaPlayerCustomSourceSeekWhence](70083#MediaPlayerCustomSourceSeekWhence) | **返回值** 定位成功，返回偏移后的位置信息，或返回音频数据的大小。定位失败，返回 -1。 # ISnapshotResultCallback ```java public interface com.ss.bytertc.engine.video.ISnapshotResultCallback ``` 截图的回调。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onTakeLocalSnapshotResult](#ISnapshotResultCallback-ontakelocalsnapshotresult) | | void | [onTakeRemoteSnapshotResult](#ISnapshotResultCallback-ontakeremotesnapshotresult) | ## 函数说明 ### onTakeLocalSnapshotResult ```java void com.ss.bytertc.engine.video.ISnapshotResultCallback.onTakeLocalSnapshotResult( long taskId, IVideoSource videoSource, Bitmap image, int errorCode ) ``` 调用 [takeLocalSnapshot](70080#RTCEngine-takelocalsnapshot) 截取视频画面时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | taskId | long | 本地截图任务的编号。和 [takeLocalSnapshot](70080#RTCEngine-takelocalsnapshot) 的返回值一致。 | | videoSource | IVideoSource | 预留参数。 | | image | Bitmap | 截图。你可以保存为文件，或对其进行二次处理。截图失败时，为空。 | | errorCode | int | 截图错误码：

0：成功
-1：截图错误。生成图片数据失败或 RGBA 编码失败
-2：截图错误。流无效。
-3：截图错误。截图超时,超时时间 1 秒。

| ### onTakeRemoteSnapshotResult ```java void com.ss.bytertc.engine.video.ISnapshotResultCallback.onTakeRemoteSnapshotResult( long taskId, String streamId, StreamInfo streamInfo, Bitmap image, int errorCode ) ``` 调用 [takeRemoteSnapshot](70080#RTCEngine-takeremotesnapshot) 截取视频画面时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | taskId | long | 远端截图任务的编号。和 [takeRemoteSnapshot](70080#RTCEngine-takeremotesnapshot) 的返回值一致。 | | streamId | String | 截图的远端流 ID。 | | streamInfo | StreamInfo | 截图的远端流信息，参看 [StreamInfo](70083#StreamInfo)。 | | image | Bitmap | 截图。你可以保存为文件，或对其进行二次处理。截图失败时，为空。 | | errorCode | int | 截图错误码：

0：成功
-1：截图错误。生成图片数据失败或 RGBA 编码失败
-2：截图错误。流无效。
-3：截图错误。截图超时,超时时间 1 秒。

| # IAudioFrameProcessor ```java public interface com.ss.bytertc.engine.IAudioFrameProcessor ``` 自定义音频处理器。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [onProcessRecordAudioFrame](#IAudioFrameProcessor-onprocessrecordaudioframe) | | int | [onProcessPlayBackAudioFrame](#IAudioFrameProcessor-onprocessplaybackaudioframe) | | int | [onProcessRemoteUserAudioFrame](#IAudioFrameProcessor-onprocessremoteuseraudioframe) | | int | [onProcessEarMonitorAudioFrame](#IAudioFrameProcessor-onprocessearmonitoraudioframe) | | int | [onProcessScreenAudioFrame](#IAudioFrameProcessor-onprocessscreenaudioframe) | ## 函数说明 ### onProcessRecordAudioFrame ```java int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessRecordAudioFrame(IAudioFrame audioFrame) ``` 回调本地采集的音频帧地址，供自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频帧地址，参看 [IAudioFrame](70083#IAudioFrame)。 | **返回值** - 0：成功。 - < 0：失败。 **注意** - 完成自定义音频处理后，SDK 会对处理后的音频帧进行编码，并传输到远端。此音频处理不会影响软件耳返音频数据。 - 要启用此回调，必须调用 [enableAudioProcessor](70080#RTCEngine-enableaudioprocessor)，并在参数中选择本地采集的音频，每 10 ms 收到此回调。 ### onProcessPlayBackAudioFrame ```java int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessPlayBackAudioFrame(IAudioFrame audioFrame) ``` 回调远端音频混音的音频帧地址，供自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频帧地址，参看 [IAudioFrame](70083#IAudioFrame) | **注意** 调用 [enableAudioProcessor](70080#RTCEngine-enableaudioprocessor)，并在参数中选择远端音频流的的混音音频时，每 10 ms 收到此回调。 ### onProcessRemoteUserAudioFrame ```java int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessRemoteUserAudioFrame( String streamId, StreamInfo streamInfo, IAudioFrame audioFrame ) ``` 回调单个远端用户的音频帧地址，供自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | String | 远端流 ID。 | | streamInfo | StreamInfo | 远端流信息, 参看 [StreamInfo](70083#StreamInfo)。 | | audioFrame | IAudioFrame | 音频帧地址，参看 [IAudioFrame](70083#IAudioFrame)。 | **注意** 调用 [enableAudioProcessor](70080#RTCEngine-enableaudioprocessor)，并在参数中选择各个远端音频流时，每 10 ms 收到此回调。 ### onProcessEarMonitorAudioFrame ```java int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessEarMonitorAudioFrame(IAudioFrame audioFrame) ``` > Available since 3.50 软件耳返音频数据的回调。你可根据此回调自定义处理音频。软件耳返音频中包含通过调用 `setVoiceReverbType` 和 `setVoiceChangerType` 设置的音频特效。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频帧地址。参看 [IAudioFrame](70083#IAudioFrame)。 | **返回值** - 0：成功。 - < 0：失败。 **注意** - 此数据处理只影响软件耳返音频数据。 - 要启用此回调，必须调用 [enableAudioProcessor](70080#RTCEngine-enableaudioprocessor)，并选择软件耳返音频，每 10 ms 收到此回调。 ### onProcessScreenAudioFrame ```java int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessScreenAudioFrame(IAudioFrame audioFrame) ``` 屏幕共享的音频帧地址回调。你可根据此回调自定义处理音频。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audioFrame | IAudioFrame | 音频帧地址，参看 [IAudioFrame](70083#IAudioFrame)。 | **注意** 调用 [enableAudioProcessor](70080#RTCEngine-enableaudioprocessor)，把返回给音频处理器的音频类型设置为屏幕共享音频后，每 10 ms 收到此回调。

实时音视频