public abstract class com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler
java

自定义编码帧回调类

public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.OnStart(
    StreamIndex index)
java

提示自定义编码帧可以开始推送的回调。

收到该回调后，你即可调用 pushExternalEncodedVideoFrame 向 SDK 推送自定义编码视频帧

传入参数

public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.OnStop(
    StreamIndex index)
java

当收到该回调时，你需停止向 SDK 推送自定义编码视频帧

传入参数

public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.OnRateUpdate(
    StreamIndex stream_index,
    int video_index,
    int fps,
    int bitrateKbps)
java

当自定义编码流的帧率或码率发生变化时，触发该回调

传入参数

public abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.OnRequestKeyFrame(
    StreamIndex stream_index,
    int video_index)
java

提示流发布端需重新生成关键帧的回调

传入参数

public interface com.ss.bytertc.engine.handler.IRTCEncryptionHandler
java

加密事件回调接口

public byte[] com.ss.bytertc.engine.handler.IRTCEncryptionHandler.onEncryptData(
    byte[] data)
java

自定义加密

传入参数

返回值
加密后的数据

public byte[] com.ss.bytertc.engine.handler.IRTCEncryptionHandler.onDecryptData(
    byte[] data)
java

自定义解密

传入参数

返回值
解密后的数据

public abstract class com.ss.bytertc.engine.handler.IRTCRoomEventHandler
java

房间事件回调接口

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onLeaveRoom(
    RTCRoomStats stats)
java

离开房间成功回调。

用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有通话相关的音视频资源后，通过此回调通知用户离开房间成功。

传入参数

注意

• 用户调用 leaveRoom 方法离开房间后，如果立即调用 destroyRTCVideo 方法销毁 RTC 引擎，则将无法收到此回调事件。
• 离开房间后，如果 App 需要使用系统音视频设备，则建议在收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备导致初始化失败。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomStateChanged(
    String roomId,
    String uid,
    int state,
    String extraInfo)
java

房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onStreamStateChanged(
    String roomId,
    String uid,
    int state,
    String extraInfo)
java

流状态改变回调，发生流相关的警告或错误时会收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAVSyncStateChange(
    AVSyncState state)
java

发布端调用 setMultiDeviceAVSync 后音视频同步状态发生改变时，会收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomStats(
    RTCRoomStats stats)
java

房间通话统计信息回调。

用户进房开始通话后，每 2s 收到一次本回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserJoined(
    UserInfo userInfo,
    int elapsed)
java

可见用户加入房间，或房内隐身用户切换为可见的回调。

1.远端用户调用 setUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。

2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。

3.房间内隐身远端用户调用 setUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。

4.新进房用户也会收到进房前已在房内的主播角色用户的进房回调通知。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserLeave(
    String uid,
    int reason)
java

远端用户离开房间，或切至不可见时，房间内其他用户会收到此事件

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onTokenWillExpire()
java

Token 过期前 30 秒将触发该回调。

调用 updateToken 更新 Token。否则 Token 过期后，用户将被移出房间无法继续进行音视频通话。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserPublishStream(
    String uid,
    MediaStreamType type)
java

房间内新增远端摄像头/麦克风采集音视频流的回调。

传入参数

注意
当房间内的远端用户调用 publishStream 成功发布由摄像头/麦克风采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 subscribeStream 订阅此流。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserUnpublishStream(
    String uid,
    MediaStreamType type,
    StreamRemoveReason reason)
java

房间内远端摄像头/麦克风采集的媒体流移除的回调。

传入参数

注意
收到该回调通知后，你可以自行选择是否调用 unsubscribeStream 取消订阅此流。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserPublishScreen(
    String uid,
    MediaStreamType type)
java

房间内新增远端屏幕共享音视频流的回调。

传入参数

注意
当房间内的远端用户调用 publishScreen 成功发布来自屏幕共享的音视频流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 subscribeScreen 订阅此流。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserUnpublishScreen(
    String uid,
    MediaStreamType type,
    StreamRemoveReason reason)
java

房间内远端屏幕共享音视频流移除的回调。

传入参数

注意
收到该回调通知后，你可以自行选择是否调用 unsubscribeScreen 取消订阅此流。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onLocalStreamStats(
    LocalStreamStats stats)
java

反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调。

本地用户发布音视频流成功后，每隔 2s 收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRemoteStreamStats(
    RemoteStreamStats stats)
java

反映通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况的回调。每隔 2s 收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onStreamSubscribed(
    int stateCode,
    String userId,
    SubscribeConfig info)
java

关于订阅媒体流状态改变的回调

传入参数

注意
本地用户收到该回调的时机包括：

• 调用 subscribeStream 或 unsubscribeStream 订阅/取消订阅指定远端摄像头音视频流后；
• 调用 subscribeScreen 或 unsubscribeScreen 订阅/取消订阅指定远端屏幕共享流后。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomMessageReceived(
    String uid,
    String message)
java

接收到房间内广播消息的回调。

房间内其他用户调用 sendRoomMessage 发送广播消息时，收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomBinaryMessageReceived(
    String uid,
    ByteBuffer message)
java

接收到房间内广播二进制消息的回调。

房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserMessageReceived(
    String uid,
    String message)
java

收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserBinaryMessageReceived(
    String uid,
    ByteBuffer message)
java

收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserMessageSendResult(
    long msgid,
    int error)
java

向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。

传入参数

注意
调用 sendUserMessage 或 sendUserBinaryMessage 接口，才能收到此回调。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomMessageSendResult(
    long msgid,
    int error)
java

调用 sendRoomMessage 或 sendRoomBinaryMessage 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。

传入参数

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onVideoStreamBanned(
    String uid,
    boolean banned)
java

通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。

传入参数

注意

• 房间内指定用户被禁止/解禁视频流发送时，房间内所有用户都会收到该回调。
• 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。
• 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。
• 在控制台开启大会模式后，只有被封禁/解禁用户会收到该回调。
• 同一房间解散后再次创建，房间内状态清空。

public abstract void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onAudioStreamBanned(
    String uid,
    boolean banned)
java

通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时，触发此回调。

传入参数

注意

• 房间内指定用户被禁止/解禁音频流发送时，房间内所有用户都会收到该回调。
• 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。
• 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。
• 在控制台开启大会模式后，只有被封禁/解禁用户会收到该回调。
• 同一房间解散后再次创建，房间内状态清空。

public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onForwardStreamStateChanged(
    ForwardStreamStateInfo[] stateInfos)
java

跨房间媒体流转发状态和错误回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onForwardStreamEvent(
    ForwardStreamEventInfo[] eventInfos)
java

跨房间媒体流转发事件回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onNetworkQuality(
    NetworkQualityStats localQuality,
    NetworkQualityStats[] remoteQualities)
java

加入房间并发布或订阅流后， 以每 2 秒一次的频率，报告本地用户和已订阅的远端用户的上下行网络质量信息。

传入参数

注意
更多通话中的监测接口，详见通话中质量监测。

public abstract class com.ss.bytertc.engine.handler.IRTCVideoEventHandler
java

音视频引擎事件回调接口

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onWarning(
    int warn)
java

发生警告回调。

传入参数

注意
SDK 运行时出现了（网络或媒体相关的）警告。SDK 通常会自动恢复，警告信息可以忽略。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onError(
    int err)
java

发生错误回调。

传入参数

注意
SDK 运行时出现了（网络或媒体相关的）错误。SDK 通常无法自动恢复，你可能需要干预。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onSysStats(
    SysStats stats)
java

每2秒发生回调，通知当前cpu，内存使用的信息。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onNetworkTypeChanged(
    int type)
java

SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserStartVideoCapture(
    String roomId,
    String uid)
java

房间内的可见用户调用 startVideoCapture 开启内部视频采集时，房间内其他用户会收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserStopVideoCapture(
    String roomId,
    String uid)
java

房间内的可见用户调用 stopVideoCapture 关闭内部视频采集时，房间内其他用户会收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onCreateRoomStateChanged(
    String roomId,
    int errorCode)
java

创建房间失败回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserStartAudioCapture(
    String roomId,
    String uid)
java

房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserStopAudioCapture(
    String roomId,
    String uid)
java

房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLocalAudioStateChanged(
    LocalAudioStreamState state,
    LocalAudioStreamError error)
java

本地音频流的状态发生改变时，该回调通知当前的本地音频流状态。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onRemoteAudioStateChanged(
    RemoteStreamKey key,
    RemoteAudioState state,
    RemoteAudioStateChangeReason reason)
java

用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLocalVideoStateChanged(
    StreamIndex streamIndex,
    LocalVideoStreamState state,
    LocalVideoStreamError error)
java

本地视频流的状态发生改变时，收到该事件。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onRemoteVideoStateChanged(
    RemoteStreamKey streamKey,
    RemoteVideoState videoState,
    RemoteVideoStateChangeReason videoStateReason)
java

远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstRemoteVideoFrameRendered(
    RemoteStreamKey remoteStreamKey,
    VideoFrameInfo frameInfo)
java

SDK 内部渲染成功远端视频流首帧后，收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstRemoteVideoFrameDecoded(
    RemoteStreamKey remoteStreamKey,
    VideoFrameInfo frameInfo)
java

SDK 接收并解码远端视频流首帧后，收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstLocalVideoFrameCaptured(
    StreamIndex streamIndex,
    VideoFrameInfo frameInfo)
java

RTC SDK 在本地完成第一帧视频帧或屏幕视频帧采集时，收到此回调。

传入参数

注意
对于采集到的本地视频帧，你可以调用 setLocalVideoCanvas 或 setLocalVideoSink 在本地渲染。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLocalVideoSizeChanged(
    StreamIndex streamIndex,
    VideoFrameInfo frameInfo)
java

本地预览视频大小或旋转信息发生改变时，收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onRemoteVideoSizeChanged(
    RemoteStreamKey remoteStreamKey,
    VideoFrameInfo frameInfo)
java

远端视频大小或旋转信息发生改变时，房间内订阅此视频流的用户会收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onConnectionStateChanged(
    int state,
    int reason)
java

回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。

传入参数

注意
更多信息参见 连接状态提示。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioRouteChanged(
    AudioRoute route)
java

音频播放路由变化时，收到该回调。

传入参数

注意
插拔音频外设，或调用 setAudioRoute 都可能触发音频路由切换，详见移动端设置音频路由 。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstLocalAudioFrame(
    StreamIndex streamIndex)
java

发布音频流时，采集到第一帧音频帧，收到该回调。

传入参数

注意
如果发布音频流时，未开启本地音频采集，SDK 会推送静音帧，也会收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstRemoteAudioFrame(
    RemoteStreamKey remoteStreamKey)
java

接收到来自远端某音频流的第一帧时，收到该回调。

传入参数

注意
用户刚收到房间内订阅的每一路音频流时，都会收到该回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLogReport(
    String logType,
    JSONObject logContent)
java

上报日志时回调该事件。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onSEIMessageReceived(
    RemoteStreamKey remoteStreamKey,
    ByteBuffer message)
java

收到通过调用 sendSEIMessage 发送带有 SEI 消息的视频帧时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLoginResult(
    String uid,
    int error_code,
    int elapsed)
java

登录结果回调

传入参数

注意
调用 login 后，会收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLogout()
java

登出结果回调

注意
调用 logout 后，会收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onServerParamsSetResult(
    int error)
java

设置应用服务器参数的返回结果

传入参数

注意
调用 setServerParams 后，会收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onGetPeerOnlineStatus(
    String peerUserId,
    int status)
java

查询对端或本端用户登录状态的返回结果

传入参数

注意
必须先调用 getPeerOnlineStatus，才能收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserMessageReceivedOutsideRoom(
    String uid,
    String message)
java

收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserBinaryMessageReceivedOutsideRoom(
    String uid,
    ByteBuffer message)
java

收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserMessageSendResultOutsideRoom(
    long msgid,
    int error)
java

给房间外指定的用户发送消息的回调

传入参数

注意
当调用 sendUserMessageOutsideRoom 或 sendUserBinaryMessageOutsideRoom 发送消息后，会收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onServerMessageSendResult(
    long msgid,
    int error,
    ByteBuffer message)
java

给应用服务器发送消息的回调。

传入参数

注意
本回调为异步回调。当调用 sendServerMessage 或 sendServerBinaryMessage 接口发送消息后，会收到此回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onNetworkDetectionResult(
    NetworkDetectionLinkType type,
    int quality,
    int rtt,
    double lost_rate,
    int bitrate,
    int jitter)
java

通话前网络探测结果。

成功调用 startNetworkDetection 接口开始探测后，会在 3s 内首次收到该回调，之后每 2s 收到一次该回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onNetworkDetectionStopped(
    NetworkDetectionStopReason reason)
java

通话前网络探测结束
以下情况将停止探测并收到本一次本回调：

1. 当调用 stopNetworkDetection 接口停止探测后，会收到一次该回调；
2. 当收到远端/本端音频首帧后，停止探测；
3. 当探测超过3分钟后，停止探测；
4. 当探测链路断开一定时间之后，停止探测。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onSimulcastSubscribeFallback(
    RemoteStreamSwitch event)
java

音视频流因网络环境变化等原因发生回退，或从回退中恢复时，触发该回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onPerformanceAlarms(
    PerformanceAlarmMode mode,
    String roomId,
    PerformanceAlarmReason reason,
    SourceWantedData data)
java

本地未开启发布性能回退，检测到设备性能不足时，收到此回调。

本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioFrameSendStateChanged(
    String roomId,
    RtcUser user,
    FirstFrameSendState state)
java

本地音频首帧发送状态发生改变时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onVideoFrameSendStateChanged(
    String roomId,
    RtcUser user,
    FirstFrameSendState state)
java

本地视频首帧发送状态发生改变时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onScreenVideoFrameSendStateChanged(
    String roomId,
    RtcUser user,
    FirstFrameSendState state)
java

屏幕共享流的视频首帧发送状态发生改变时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioFramePlayStateChanged(
    String roomId,
    RtcUser user,
    FirstFramePlayState state)
java

音频首帧播放状态发生改变时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onVideoFramePlayStateChanged(
    String roomId,
    RtcUser user,
    FirstFramePlayState state)
java

视频首帧播放状态发生改变时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onScreenVideoFramePlayStateChanged(
    String roomId,
    RtcUser user,
    FirstFramePlayState state)
java

屏幕共享流视频首帧播放状态发生改变时，收到此回调

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioDeviceStateChanged(
    String device_id,
    AudioDeviceType device_type,
    int device_state,
    int device_error)
java

音频设备状态回调。提示音频采集、音频播放等媒体设备的状态。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onVideoDeviceStateChanged(
    String device_id,
    VideoDeviceType device_type,
    int device_state,
    int device_error)
java

视频设备状态回调。提示摄像头视频采集、屏幕视频采集等媒体设备的状态。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioDeviceWarning(
    String device_id,
    AudioDeviceType device_type,
    int device_warning)
java

音频设备警告回调。音频设备包括音频采集设备、音频渲染设备等。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onVideoDeviceWarning(
    String device_id,
    VideoDeviceType device_type,
    int device_warning)
java

视频设备警告回调，包括视频采集等设备。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onHttpProxyState(
    int state)
java

HTTP 代理连接状态改变时，收到该回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onHttpsProxyState(
    int state)
java

HTTPS 代理连接状态改变时，收到该回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onSocks5ProxyState(
    int state,
    String cmd,
    String proxy_address,
    String local_address,
    String remote_address)
java

SOCKS5 代理状态改变时，收到该回调。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onRecordingStateUpdate(
    StreamIndex type,
    RecordingState state,
    RecordingErrorCode errorCode,
    RecordingInfo info)
java

获取本地录制状态回调。

该回调由 startFileRecording 或 stopFileRecording 触发。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onRecordingProgressUpdate(
    StreamIndex type,
    RecordingProgress progress,
    RecordingInfo info)
java

本地录制进度回调。

该回调由 startFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioMixingStateChanged(
    int mixId,
    AudioMixingState state,
    AudioMixingError error)
java

音频混音文件播放状态改变时回调

传入参数

注意
此回调会被触发的时机汇总如下：

• 当调用 startAudioMixing 方法成功后，会触发 state 值为 AUDIO_MIXING_STATE_PLAYING 回调；否则触发 state 值为 AUDIO_MIXING_STATE_FAILED 的回调。
• 当使用相同的 ID 重复调用 startAudioMixing 后，后一次会覆盖前一次，且本回调会以 AUDIO_MIXING_STATE_STOPPED 通知前一次混音已停止。
• 当调用 pauseAudioMixing 方法暂停播放成功后， 会触发 state 值为 AUDIO_MIXING_STATE_PAUSED 回调；否则触发 state 值为 AUDIO_MIXING_STATE_FAILED 的回调。
• 当调用 resumeAudioMixing 方法恢复播放成功后，会触发 state 值为 AUDIO_MIXING_STATE_PLAYING 回调；否则触发 state 值为 AUDIO_MIXING_STATE_FAILED 的回调。
• 当调用 stopAudioMixing 方法暂停止播放成功后， 会触发 state 值为 AUDIO_MIXING_STATE_STOPPED 回调；否则触发 state 值为 AUDIO_MIXING_STATE_FAILED 的回调。
• 播放结束会触发 state 值为 AUDIO_MIXING_STATE_FINISHED 回调。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioMixingPlayingProgress(
    int mixId,
    long progress)
java

混音音频文件播放进度回调

传入参数

注意
调用 setAudioMixingProgressInterval 将时间间隔设为大于 0 的值后，或调用 startAudioMixing 将 AudioMixingConfig 中的时间间隔设为大于 0 的值后，SDK 会按照设置的时间间隔回调该事件。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLocalAudioPropertiesReport(
    LocalAudioPropertiesInfo[] audioPropertiesInfos)
java

调用 enableAudioPropertiesReport 后，根据设置的 interval 值，你会周期性地收到此回调，了解本地音频的相关信息。

本地音频包括使用 RTC SDK 内部机制采集的麦克风音频和屏幕音频。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioPlaybackDeviceTestVolume(
    int volume)
java

回调音频设备测试时的播放音量

传入参数

注意
调用 startAudioPlaybackDeviceTest 或 startAudioDeviceRecordTest，开始播放音频文件或录音时，将开启该回调。本回调为周期性回调，回调周期由上述接口的 interval 参数指定。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onRemoteAudioPropertiesReport(
    RemoteAudioPropertiesInfo[] audioPropertiesInfos,
    int totalRemoteVolume)
java

远端用户进房后，本地调用 enableAudioPropertiesReport ，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的音频信息。

远端用户的音频包括使用 RTC SDK 内部机制/自定义机制采集的麦克风音频和屏幕音频。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onActiveSpeaker(
    String roomId,
    String uid)
java

调用 enableAudioPropertiesReport 后，根据设置的 AudioPropertiesConfig.interval，你会周期性地收到此回调，获取房间内的最活跃用户信息。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onStreamSyncInfoReceived(
    RemoteStreamKey streamKey,
    StreamSycnInfoConfig.SyncInfoStreamType streamType,
    ByteBuffer data)
java

音频流同步信息回调。可以通过此回调，在远端用户调用 sendStreamSyncInfo 发送音频流同步消息后，收到远端发送的音频流同步信息。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onPushPublicStreamResult(
    String roomId,
    String publicStreamId,
    int error)
java

公共流发布结果回调。

调用 startPushPublicStream 接口发布公共流后，启动结果通过此回调方法通知用户。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onPlayPublicStreamResult(
    String publicStreamId,
    int error)
java

订阅公共流的结果回调

调用 startPlayPublicStream 接口启动拉公共流功能后，通过此回调收到启动结果和拉流过程中的错误。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onPublicStreamSEIMessageReceived(
    String publicStreamId,
    ByteBuffer message)
java

回调公共流中包含的 SEI 信息

调用 startPlayPublicStream 接口启动拉公共流功能后，通过此回调收到公共流中的SEI消息。

传入参数

注意
当公共流中的多路视频流均包含有 SEI 信息时：SEI 不互相冲突时，将通过多次回调分别发送；
SEI 在同一帧有冲突时，则只有一条流中的 SEI 信息被透传并融合到公共流中。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstPublicStreamVideoFrameDecoded(
    String publicStreamId,
    VideoFrameInfo videoFrameInfo)
java

公共流的首帧视频解码成功

关于订阅公共流，详见 startPlayPublicStream。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onFirstPublicStreamAudioFrame(
    String publicStreamId)
java

公共流的音频首帧解码成功

关于订阅公共流，详见 startPlayPublicStream。

传入参数

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onEchoTestResult(
    EchoTestResult result)
java

关于音视频回路测试结果的回调。

传入参数

注意
该回调触发的时机包括： + 检测过程中采集设备发生错误时；

• 检测成功后；
• 非设备原因导致检测过程中未接收到音/视频回放，停止检测后。

public void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onCloudProxyConnected(
    int interval)
java

调用 startCloudProxy 开启云代理，SDK 首次成功连接云代理服务器时，回调此事件。

传入参数

public interface com.ss.bytertc.engine.live.ILiveTranscodingObserver
java

转推直播观察者。

boolean com.ss.bytertc.engine.live.ILiveTranscodingObserver.isSupportClientPushStream()
java

是否具有推流能力。

• false：不具备推流能力（默认值）
  
• true：具备推流能力

注意

• 如果需要开启端云一体转推直播功能，你必须确保你的 App 包含 librtmp，具有推流能力。此时，设置该回调为 true。

void com.ss.bytertc.engine.live.ILiveTranscodingObserver.onStreamMixingEvent(
    ByteRTCStreamMixingEvent eventType,
    String taskId,
    ByteRTCTranscoderErrorCode error,
    ByteRTCStreamMixingType mixType)
java

转推直播状态回调

传入参数

void com.ss.bytertc.engine.live.ILiveTranscodingObserver.onMixingAudioFrame(
    String taskId,
    byte[] audioFrame,
    int frameNum)
java

端云一体合流音频 PCM 回调

传入参数

注意
收到该回调的周期为每 10 毫秒一次，并且每次的音频数据量为 10 毫秒数据量。

void com.ss.bytertc.engine.live.ILiveTranscodingObserver.onMixingVideoFrame(
    String taskId,
    VideoFrame videoFrame)
java

端云一体合流视频 YUV 回调

传入参数

注意

• 收到该回调的周期与视频的帧间隔一致。
• 为避免内存泄露，你应在回调中手动释放视频帧：

public void onMixingVideoFrame(String taskId, VideoFrame videoFrame){
videoFrame.release()
}

void com.ss.bytertc.engine.live.ILiveTranscodingObserver.onDataFrame(
    String taskId,
    byte[] dataFrame,
    long time)
java

端云一体合流视频 SEI 数据回调

传入参数

public interface com.ss.bytertc.engine.live.IPushSingleStreamToCDNObserver
java

单流转推直播观察者。

void com.ss.bytertc.engine.live.IPushSingleStreamToCDNObserver.onStreamPushEvent(
    ByteRTCStreamSinglePushEvent eventType,
    String taskId,
    int error)
java

单流转推直播状态回调

传入参数

public interface com.ss.bytertc.engine.video.IFaceDetectionObserver
java

人脸检测结果回调观察者

public void com.ss.bytertc.engine.video.IFaceDetectionObserver.onFaceDetectResult(
    FaceDetectionResult result)
java

特效 SDK 进行人脸检测结果的回调。

调用 registerFaceDetectionObserver 注册了 IFaceDetectionObserver，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。

传入参数

public interface com.ss.bytertc.engine.IRangeAudioObserver
java

范围语音衰减系数监测器

void com.ss.bytertc.engine.IRangeAudioObserver.onRangeAudioInfo(
    RangeAudioInfo[] range_audio_info)
java

关于当前范围语音衰减系数的回调。

手动订阅的场景下，房间内任一用户调用 updatePosition 更新自身位置或调用 updateReceiveRange 更新语音接收范围时，该用户与房间内其他用户的相对距离都会发生改变，据此计算的衰减系数也会发生改变，并通过该回调通知用户。

你可以通过关注该回调中包含的远端用户的衰减系数决定是否订阅该远端用户的流。

传入参数

注意
更新自身位置或语音接收范围后，并不会马上触发该回调。SDK 会每 500 ms 计算一次衰减系数，并且只在计算结果与上次不同，或结果相同但是距离上次计算已超过 3 秒的时候推送回调。

public interface com.ss.bytertc.engine.ISingScoringEventHandler
java

K 歌评分事件回调类。

void com.ss.bytertc.engine.ISingScoringEventHandler.onCurrentScoringInfo(
    SingScoringRealtimeInfo info)
java

实时评分信息回调。调用 startSingScoring 后，会收到该回调。

传入参数

public interface com.ss.bytertc.engine.mediaio.ILocalEncodedVideoFrameObserver
java

本地视频帧监测器

void com.ss.bytertc.engine.mediaio.ILocalEncodedVideoFrameObserver.onLocalEncodedVideoFrame(
    StreamIndex streamIndex,
    RTCEncodedVideoFrame encodedVideoFrame)
java

调用 registerLocalEncodedVideoFrameObserver 后，SDK 每次使用内部采集，采集到一帧视频帧，或收到一帧外部视频帧时，都会回调该事件。

传入参数

注意
encodedVideoFrame 只在回调函数作用域内有效，不要存储该参数并在其它函数内访问该参数的内存数据

public abstract class com.ss.bytertc.engine.mediaio.IRemoteEncodedVideoFrameObserver
java

远端编码后视频数据监测器

public abstract void com.ss.bytertc.engine.mediaio.IRemoteEncodedVideoFrameObserver.OnRemoteEncodedVideoFrame(
    RemoteStreamKey stream_info,
    RTCEncodedVideoFrame video_stream)
java

调用 registerRemoteEncodedVideoFrameObserver 后，SDK 监测到远端编码后视频数据时，触发该回调

传入参数

注意
encodedVideoFrame 只在回调函数作用域内有效，不要存储该参数并在其它函数内访问该参数的内存数据

public interface com.ss.bytertc.engine.video.ISnapshotResultCallback
java

截图的回调。

void com.ss.bytertc.engine.video.ISnapshotResultCallback.onTakeLocalSnapshotResult(
    long taskId,
    StreamIndex streamIndex,
    Bitmap image,
    int errorCode)
java

调用 takeLocalSnapshot 截取视频画面时，收到此回调。

传入参数

void com.ss.bytertc.engine.video.ISnapshotResultCallback.onTakeRemoteSnapshotResult(
    long taskId,
    RemoteStreamKey streamKey,
    Bitmap image,
    int errorCode)
java

调用 takeRemoteSnapshot 截取视频画面时，收到此回调。

传入参数

public interface com.ss.bytertc.engine.IAudioFrameObserver
java

音频数据回调观察者

void com.ss.bytertc.engine.IAudioFrameObserver.onRecordAudioFrame(
    IAudioFrame audioFrame)
java

返回麦克风录制的音频数据

传入参数

void com.ss.bytertc.engine.IAudioFrameObserver.onPlaybackAudioFrame(
    IAudioFrame audioFrame)
java

返回订阅的远端所有用户混音后的音频数据

传入参数

void com.ss.bytertc.engine.IAudioFrameObserver.onRemoteUserAudioFrame(
    RemoteStreamKey stream_info,
    IAudioFrame audioFrame)
java

返回远端单个用户的音频数据

传入参数

注意
此回调在播放线程调用。不要在此回调中做任何耗时的事情，否则可能会影响整个音频播放链路。

void com.ss.bytertc.engine.IAudioFrameObserver.onMixedAudioFrame(
    IAudioFrame audioFrame)
java

返回本地麦克风录制和订阅的所有远端用户混音后的音频数据

传入参数

public interface com.ss.bytertc.engine.IAudioFrameProcessor
java

自定义音频处理器。

int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessRecordAudioFrame(
    IAudioFrame audioFrame)
java

回调本地采集的音频帧地址，供自定义音频处理。

传入参数

注意

• 完成自定义音频处理后，SDK 会对处理后的音频帧进行编码，并传输到远端。
• 调用 enableAudioProcessor，并在参数中选择本地采集的音频时，收到此回调。

int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessPlayBackAudioFrame(
    IAudioFrame audioFrame)
java

回调远端音频混音的音频帧地址，供自定义音频处理。

传入参数

注意
调用 enableAudioProcessor，并在参数中选择远端音频流的的混音音频时，收到此回调。

int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessRemoteUserAudioFrame(
    RemoteStreamKey stream_info,
    IAudioFrame audioFrame)
java

回调单个远端用户的音频帧地址，供自定义音频处理。

传入参数

注意
调用 enableAudioProcessor，并在参数中选择各个远端音频流时，收到此回调。

int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessEarMonitorAudioFrame(
    IAudioFrame audioFrame)
java

软件耳返音频数据的回调。你可根据此回调自定义处理音频。

传入参数

注意

• 此数据处理只影响耳返音频数据。
• 调用 enableAudioProcessor，把返回给音频处理器的音频类型设置为耳返音频后，你将收到此回调。

int com.ss.bytertc.engine.IAudioFrameProcessor.onProcessScreenAudioFrame(
    IAudioFrame audioFrame)
java

屏幕共享的音频帧地址回调。你可根据此回调自定义处理音频。

传入参数

注意
调用 enableAudioProcessor，把返回给音频处理器的音频类型设置为屏幕共享音频后，你将收到此回调。

public abstract class com.ss.bytertc.ktv.IKTVEventHandler
java

KTV 事件回调接口。

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onMusicListResult(
    int errorCode,
    int totalSize,
    Music[] musics)
java

歌曲列表回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onSearchMusicResult(
    int errorCode,
    int totalSize,
    Music[] musics)
java

搜索歌曲结果回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onHotMusicResult(
    int errorCode,
    HotMusicInfo[] hotMusics)
java

热榜歌曲结果回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onMusicDetailResult(
    int errorCode,
    Music music)
java

歌曲详细信息回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onDownloadSuccess(
    int downloadId,
    DownloadResult result)
java

下载成功回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onDownloadFail(
    int downloadId,
    int errorCode)
java

下载失败回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVEventHandler.onDownloadMusicProgress(
    int downloadId,
    int downloadProgress)
java

歌曲文件下载进度回调。

传入参数

public abstract class com.ss.bytertc.ktv.IKTVPlayerEventHandler
java

KTV 播放器回调接口。

public abstract void com.ss.bytertc.ktv.IKTVPlayerEventHandler.onPlayProgress(
    @NonNull String musicId,
    long progress)
java

音乐播放进度回调。

传入参数

public abstract void com.ss.bytertc.ktv.IKTVPlayerEventHandler.onPlayStateChange(
    int errorCode,
    @NonNull String musicId,
    @NonNull PlayState playState)
java

音乐播放状态改变回调。

传入参数

注意
此回调被触发的时机汇总如下：

• 调用 playMusic 成功后，会触发 playState 值为 PLAY_STATE_PLAYING 的回调；否则会触发 playState 值为 PLAY_STATE_FAILED 的回调。
• 使用相同的音乐 ID 重复调用 playMusic 后，后一次播放会覆盖前一次，且会触发 playState 值为 PLAY_STATE_PLAYING 的回调，表示后一次音乐播放已开始。
• 调用 pauseMusic 方法暂停播放成功后，会触发 playState 值为 PLAY_STATE_PAUSED 的回调；否则触发 playState 值为 PLAY_STATE_FAILED 的回调。
• 调用 resumeMusic 方法恢复播放成功后，会触发 playState 值为 PLAY_STATE_PLAYING 的回调；否则触发 playState 值为 PLAY_STATE_FAILED 的回调。
• 调用 stopMusic 方法停止播放成功后，会触发 playState 值为 PLAY_STATE_STOPPED 的回调；否则触发 playState 值为 PLAY_STATE_FAILED 的回调。
• 音乐播放结束会触发 playState 值为 PLAY_STATE_FINISHED 的回调。