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

房间事件回调接口

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

离开房间成功回调。

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

传入参数

注意

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

房间内通话统计信息回调。

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

传入参数

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

远端可见用户加入房间，或房内不可见用户切换为可见的回调。

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

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

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

4.新进房用户也会收到进房前已在房内的可见用户的进房回调通知。

传入参数

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

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

传入参数

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

Token 进房权限过期前 30 秒将触发该回调。

收到该回调后，你需调用 updateToken 更新 Token 进房权限。

注意

若 Token 进房权限过期且未及时更新：

• 用户此时尝试进房会收到 onRoomStateChanged 回调，提示错误码为 -1000 Token 无效；
• 用户已在房间内则会被移出房间，本地用户会收到 onRoomStateChanged 回调，提示错误码为 -1009 Token 无效，同时远端用户会收到 onUserLeave 回调，提示原因为 1 Token 进房权限过期。

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onPublishPrivilegeTokenWillExpire()
java

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

收到该回调后，你需调用 updateToken 更新 Token 发布权限。

注意

若收到该回调后未及时更新 Token，Token 发布权限过期后：

• 此时尝试发布流会收到 onStreamStateChanged 回调，提示错误码为 -1002 没有发布权限；
• 已在发布中的流会停止发布，发布端会收到 onStreamStateChanged 回调，提示错误码为 -1002 没有发布权限，同时远端用户会收到 onUserUnpublishStream/ onUserUnpublishScreen 回调，提示原因为 6 发流端发布权限过期。

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSubscribePrivilegeTokenWillExpire()
java

Token 订阅权限过期前 30 秒将触发该回调。

收到该回调后，你需调用 updateToken 更新 Token 订阅权限有效期。

注意

若收到该回调后未及时更新 Token，Token 订阅权限过期后，尝试新订阅流会失败，已订阅的流会取消订阅，并且会收到 onStreamStateChanged 回调，提示错误码为 -1003 没有订阅权限。

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

本地流数据统计以及网络质量回调。

本地用户发布流成功后，SDK 会周期性（2s）的通过此回调事件通知用户发布的流在此次统计周期内的质量统计信息。

统计信息通过 LocalStreamStats 类型的回调参数传递给用户，其中包括发送音视频比特率、发送帧率、编码帧率，网络质量等。

传入参数

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

本地订阅的远端音/视频流数据统计以及网络质量回调。

本地用户订阅流成功后，SDK 会周期性（2s）的通过此回调事件通知用户订阅的流在此次统计周期内的质量统计信息，包括：发送音视频比特率、发送帧率、编码帧率，网络质量等。

传入参数

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

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

传入参数

注意

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

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

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

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

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

传入参数

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

注意

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

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

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

传入参数

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

注意

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

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSetRoomExtraInfoResult(
    long taskId,
    SetRoomExtraInfoResult error
)
java

Available since 3.52

调用 setRoomExtraInfo 设置房间附加信息结果的回调。

传入参数

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomExtraInfoUpdate(
    String key,
    String value,
    String lastUpdateUserId,
    long lastUpdateTimeMs
)
java

Available since 3.52

接收同一房间内，其他用户调用 setRoomExtraInfo 设置的房间附加信息的回调。

传入参数

注意

新进房的用户会收到进房前房间内已有的全部附加信息通知。

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onUserVisibilityChanged(
    boolean currentUserVisibility,
    UserVisibilityChangeError errorCode
)
java

Available since 3.54

用户调用 setUserVisibility 设置用户可见性的回调。

传入参数

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSubtitleStateChanged(
    SubtitleState state,
    SubtitleErrorCode errorCode,
    String errorMessage
)
java

字幕状态发生改变回调。

当用户调用 startSubtitle 和 stopSubtitle 使字幕状态发生改变或字幕任务出现错误时，触发该回调。

传入参数

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onSubtitleMessageReceived(SubtitleMessage[] subtitles)
java

字幕相关内容回调。

当用户成功调用 startSubtitle 后会收到此回调，通知字幕的相关信息。

传入参数

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomWarning(int warn)
java

Deprecated since 3.41 and will be deleted in 3.51, use onRoomStateChanged and onStreamStateChanged instead.

发生警告回调。

传入参数

注意

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

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onRoomError(int err)
java

Deprecated since 3.41 and will be deleted in 3.51, use onRoomStateChanged and onStreamStateChanged instead.

发生错误回调。

传入参数

注意

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

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onStreamRemove(
    RTCStream stream,
    StreamRemoveReason reason
)
java

Deprecated since 3.36 and will be deleted in 3.51, use onUserUnpublishStream and onUserUnpublishScreen instead.

房间内远端流移除回调。

房间内的远端用户停止发布音视频流时，本地用户会收到此回调通知。

传入参数

void com.ss.bytertc.engine.handler.IRTCRoomEventHandler.onStreamAdd(RTCStream stream)
java

Deprecated since 3.36 and will be deleted in 3.51, use onUserPublishStream and onUserPublishScreen instead.

房间内新流发布回调。

房间内的远端用户发布新的音视频流时，本地用户会收到此回调通知。

传入参数

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

KTV 播放器回调接口。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

音乐播放进度回调。

传入参数

abstract void com.ss.bytertc.ktv.IKTVPlayerEventHandler.onPlayStateChanged(
    @NonNull String musicId,
    @NonNull PlayState playState,
    KTVPlayerErrorCode errorCode
)
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 的回调。

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

IAudioEffectPlayer 对应的回调句柄。你必须调用 setEventHandler 完成设置后，才能收到对应回调。

void com.ss.bytertc.engine.IAudioEffectPlayerEventHandler.onAudioEffectPlayerStateChanged(
    int effectId,
    PlayerState state,
    PlayerError error
)
java

播放状态改变时回调。

传入参数

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

单流转推直播观察者。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

单流转推直播状态回调

传入参数

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

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

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

abstract void com.ss.bytertc.engine.mediaio.IRemoteEncodedVideoFrameObserver.onRemoteEncodedVideoFrame(
    RemoteStreamKey streamKey,
    RTCEncodedVideoFrame encodedVideoFrame
)
java

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

传入参数

注意

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

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

KTV 事件回调接口。

abstract void com.ss.bytertc.ktv.IKTVManagerEventHandler.onMusicListResult(
    MusicInfo[] musicInfos,
    int totalSize,
    KTVErrorCode errorCode
)
java

歌曲列表回调。

传入参数

abstract void com.ss.bytertc.ktv.IKTVManagerEventHandler.onSearchMusicResult(
    MusicInfo[] musicInfos,
    int totalSize,
    KTVErrorCode errorCode
)
java

搜索歌曲结果回调。

传入参数

abstract void com.ss.bytertc.ktv.IKTVManagerEventHandler.onHotMusicResult(
    HotMusicInfo[] hotMusics,
    KTVErrorCode errorCode
)
java

热榜歌曲结果回调。

传入参数

abstract void com.ss.bytertc.ktv.IKTVManagerEventHandler.onMusicDetailResult(
    MusicInfo musicInfo,
    KTVErrorCode errorCode
)
java

歌曲详细信息回调。

传入参数

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

下载成功回调。

传入参数

abstract void com.ss.bytertc.ktv.IKTVManagerEventHandler.onDownloadFailed(
    int downloadId,
    KTVErrorCode errorCode
)
java

下载失败回调。

传入参数

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

歌曲文件下载进度回调。

传入参数

abstract void com.ss.bytertc.ktv.IKTVManagerEventHandler.onClearCacheResult(KTVErrorCode errorCode)
java

清理文件缓存结果回调。

传入参数

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

K 歌评分事件回调类。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

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

传入参数

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

人脸检测结果回调观察者

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

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

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

传入参数

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

转推直播观察者。

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

是否具有推流能力。

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

注意

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

void com.ss.bytertc.engine.live.IMixedStreamObserver.onMixingEvent(
    ByteRTCStreamMixingEvent eventType,
    String taskId,
    ByteRTCTranscoderErrorCode error,
    MixedStreamType mixType
)
java

转推直播状态回调

传入参数

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

端云一体合流音频 PCM 回调

传入参数

注意

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

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

端云一体合流视频 YUV 回调

传入参数

注意

• 收到该回调的周期与视频的帧间隔一致。
• 为避免内存泄露，你应在回调中手动释放视频帧： public void onMixingVideoFrame(String taskId, VideoFrame videoFrame){ videoFrame.release() }

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

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

传入参数

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

本地音频文件混音的音频帧观察者。

void com.ss.bytertc.engine.IMediaPlayerAudioFrameObserver.onFrame(
    int playerId,
    IAudioFrame frame
)
java

当本地音频文件混音时，回调播放的音频帧。

传入参数

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

本地音频文件混音的音频帧观察者。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

void com.ss.bytertc.engine.IAudioFileFrameObserver.onAudioFileFrame(
    int mixID,
    IAudioFrame audioFrame
)
java

当本地音频文件混音时，回调播放的音频帧。

传入参数

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

转推直播观察者。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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,
    long timeStampMs
)
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.onMixingDataFrame(
    String taskId,
    byte[] dataFrame,
    long time
)
java

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

传入参数

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

语音识别服务使用状态回调

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

void com.ss.bytertc.engine.handler.IRTCASREngineEventHandler.onSuccess()
java

语音识别服务开启成功回调

void com.ss.bytertc.engine.handler.IRTCASREngineEventHandler.onMessage(String message)
java

语音转文字成功后回调，该回调返回识别后的全量消息。

传入参数

注意

若识别过程中发生了网络连接中断，则重连后回调的信息中只包含重连后识别的文字消息，不再包含上一次连接后识别的消息。

void com.ss.bytertc.engine.handler.IRTCASREngineEventHandler.onError(
    int errorCode,
    String errorMessage
)
java

当语音识别服务内部发生错误事件时触发该回调。

传入参数

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

本地视频帧监测器

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

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

传入参数

注意

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

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

自定义编码帧回调类

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

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

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

传入参数

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

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

传入参数

abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onRateUpdate(
    StreamIndex streamIndex,
    int videoIndex,
    int fps,
    int bitrateKbps
)
java

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

传入参数

abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onRequestKeyFrame(
    StreamIndex streamIndex,
    int videoIndex
)
java

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

传入参数

abstract void com.ss.bytertc.engine.handler.IExternalVideoEncoderEventHandler.onActiveVideoLayer(
    StreamIndex streamIndex,
    int videoIndex,
    boolean active
)
java

Available since 3.56

作为自定义编码视频流的发送端，你会在视频流可发送状态发生变化时，收到此回调。

你可以根据此回调的提示，仅对可发送的视频流进行编码，以降低本端视频编码性能消耗。此回调会根据多个因素综合判断触发，包括：本端设备性能和本端网络性能，以及按需订阅场景下，远端用户是否订阅。

传入参数

注意

要收到此回调，必须调用 setVideoSourceType 设置视频源是自定义编码，且通过 setExternalVideoEncoderEventHandler 设置了回调句柄。

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

IMediaPlayer 对应的回调句柄。你必须调用 setEventHandler 完成设置后，才能收到对应回调。

void com.ss.bytertc.engine.IMediaPlayerEventHandler.onMediaPlayerStateChanged(
    int playerId,
    PlayerState state,
    PlayerError error
)
java

播放状态改变时回调。

传入参数

void com.ss.bytertc.engine.IMediaPlayerEventHandler.onMediaPlayerPlayingProgress(
    int playerId,
    long progress
)
java

播放进度周期性回调。回调周期通过 setProgressInterval 设置。

传入参数

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

音频数据回调观察者

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

本接口类中的单个回调的数据量为 20 ms 的数据量。回调周期在 20 ms 上下浮动。

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 streamKey,
    IAudioFrame audioFrame
)
java

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

传入参数

注意

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

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

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

传入参数

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

加密事件回调接口

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

自定义加密。

使用设定的自定义加密方式，对编码后传输前的音视频帧数据进行加密。

暂不支持对原始音视频帧进行加密。

传入参数

返回值

加密后的数据

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

自定义解密。

对自定义加密后的音视频帧数据进行解密。关于自定义加密，参看 onEncryptData。

传入参数

返回值

解密后的数据

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

内存播放数据源回调

int com.ss.bytertc.engine.IMediaPlayerCustomSourceProvider.onReadData(
    ByteBuffer buffer,
    int bufferSize
)
java

Available since 3.53

调用 openWithCustomSource 接口播放用户传入的内存音频数据时，会触发此回调，用户需要写入音频数据。

传入参数

返回值

返回实际读取的音频数据大小。

注意

若 openWithCustomSource 接口调用失败，请在 buffer 和 bufferSize 两个参数中填入 0。 此时 SDK 会停止调用此接口。

long com.ss.bytertc.engine.IMediaPlayerCustomSourceProvider.onSeek(
    long offset,
    MediaPlayerCustomSourceSeekWhence whence
)
java

Available since 3.53

根据设置好的内存音频数据的读取位置和读取偏移量对音频数据进行偏移，以便 SDK 读取和分析音频数据。

在调用 openWithCustomSource 接口传入内存音频数据，或者调用 setPosition 设置了音频数据的起始播放位置后，SDK 会对音频数据进行读取和分析，此时会触发该回调，你需要根据参数中设置的起始读取位置和偏移量进行操作。

传入参数

返回值

定位成功，返回偏移后的位置信息，或返回音频数据的大小。

定位失败，返回 -1。

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

音视频引擎事件回调接口

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

发生警告回调。

SDK 运行时出现了警告。SDK 通常会自动恢复，警告信息可以忽略。

传入参数

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

发生错误回调。

SDK 运行时出现了网络或媒体相关的错误，且无法自动恢复时触发此回调。

你可能需要干预.

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onDeadLockError(DeadLockMsg deadLockMsg)
java

当 RTC 内部线程发生 block 时，会触发回调。线程名与持续次数

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onExtensionAccessError(
    String extensionName,
    String msg
)
java

Available since 3.52

当访问插件失败时，收到此回调。

RTC SDK 将一些功能封装成插件。当使用这些功能时，如果插件不存在，功能将无法使用。

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

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

若发布视频数据前未开启采集，房间内所有可见用户会收到此回调。

传入参数

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

创建房间失败回调。

传入参数

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

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

传入参数

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

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

传入参数

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

本地音频流的状态发生改变时，收到此回调。

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

注意

本回调仅适用于主流，不适用于屏幕流。

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

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

传入参数

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

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

传入参数

注意

• 对于主流，进入房间后，仅在发布端第一次发布的时候，订阅端会收到该回调，此后不受重新发布的影响，只要不重新加入房间，就不会再收到该回调。
• 对于屏幕流，用户每次重新发布屏幕视频流在订阅端都会重新触发一次该回调。

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

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

传入参数

注意

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

上报日志时回调该事件。

传入参数

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

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onSEIStreamUpdate(
    RemoteStreamKey remoteStreamKey,
    SEIStreamUpdateEvent event
)
java

黑帧视频流发布状态回调。

在语音通话场景下，本地用户调用 sendSEIMessage 通过黑帧视频流发送 SEI 数据时，流的发送状态会通过该回调通知远端用户。

你可以通过此回调判断携带 SEI 数据的视频帧为黑帧，从而不对该视频帧进行渲染。

传入参数

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

登录结果回调

传入参数

注意

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

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

登出结果回调

传入参数

注意

在以下两种情况下会收到此回调：调用 logout 接口主动退出；或其他用户以相同 UserId 进行 login 导致本地用户被动登出。

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

通话前网络探测结果。

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

传入参数

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

通话前网络探测结束

以下情况将停止探测并收到本一次本回调：

1. 当调用 stopNetworkDetection 接口停止探测后，会收到一次该回调；

2. 当收到远端/本端音频首帧后，停止探测；

3. 当探测超过 3 分钟后，停止探测；

4. 当探测链路断开一定时间之后，停止探测。

传入参数

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

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

传入参数

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioDeviceStateChanged(
    String deviceID,
    AudioDeviceType deviceType,
    int deviceState,
    int deviceError
)
java

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onVideoDeviceStateChanged(
    String deviceID,
    VideoDeviceType deviceType,
    int deviceState,
    int deviceError
)
java

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioDeviceWarning(
    String deviceID,
    AudioDeviceType deviceType,
    int deviceWarning
)
java

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onVideoDeviceWarning(
    String deviceID,
    VideoDeviceType deviceType,
    int deviceWarning
)
java

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

传入参数

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

获取本地录制状态回调。

该回调由 startFileRecording 或 stopFileRecording 触发。

传入参数

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

本地录制进度回调。

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioRecordingStateUpdate(
    AudioRecordingState state,
    AudioRecordingErrorCode errorCode
)
java

调用 startAudioRecording 或 stopAudioRecording 改变音频文件录制状态时，收到此回调。

传入参数

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

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

传入参数

注意

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

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

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

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

传入参数

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

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

传入参数

注意

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

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

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

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

传入参数

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

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

传入参数

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

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

传入参数

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

公共流发布结果回调。

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

传入参数

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

订阅公共流的结果回调

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

传入参数

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

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

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

传入参数

注意

通过 Open API 插入的自定义信息，应通过回调 onPublicStreamDataMessageReceived 获取。

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onPublicStreamDataMessageReceived(
    String publicStreamId,
    ByteBuffer message,
    DataMessageSourceType sourceType
)
java

Available since 3.52

回调公共流中包含的数据信息。

调用 startPlayPublicStream 订阅公共流后，通过监听本回调获取公共流中的数据消息，包括调用 Open API 发送的 SEI 消息和音量回调。

传入参数

注意

通过调用客户端 API 插入的 SEI 信息，应通过回调 onPublicStreamSEIMessageReceived 获取。

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

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

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

传入参数

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

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

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

传入参数

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

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

传入参数

注意

该回调触发的时机包括：

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

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

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onNetworkTimeSynchronized()
java

首次调用 getNetworkTimeInfo 后，SDK 内部启动网络时间同步，同步完成时会触发此回调。

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onHardwareEchoDetectionResult(HardwareEchoDetectionResult hardwareEchoDetectionResult)
java

通话前回声检测结果回调。

传入参数

注意

• 通话前调用 startHardwareEchoDetection 后，将触发本回调返回检测结果。
• 建议在收到检测结果后，调用 stopHardwareEchoDetection 停止检测，释放对音频设备的占用。
• 如果 SDK 在通话中检测到回声，将通过 onAudioDeviceWarning 回调 MEDIA_DEVICE_WARNING_DETECT_LEAK_ECHO。

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onLocalProxyStateChanged(
    LocalProxyType localProxyType,
    LocalProxyState localProxyState,
    LocalProxyError localProxyError
)
java

本地代理状态发生改变回调。调用 setLocalProxy 设置本地代理后，SDK 会触发此回调，通知代理连接的状态。

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onExternalScreenFrameUpdate(FrameUpdateInfo info)
java

外部采集时，调用 setOriginalScreenVideoInfo 设置屏幕或窗口大小改变前的分辨率后，若屏幕采集模式为智能模式，你将收到此回调，根据 RTC 智能决策合适的帧率和分辨率积（宽*高）重新采集。

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserMuteAudio(
    String roomId,
    String uid,
    MuteState muteState
)
java

Deprecated since 3.36 and will be deleted in 3.51, use onUserPublishStream, onUserPublishScreen, onUserUnpublishStream and onUserUnpublishScreen instead.

房间内用户暂停/恢复发送音频流时，房间内其他用户会收到此回调。

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onUserMuteVideo(
    String roomId,
    String uid,
    MuteState muteState
)
java

Deprecated since 3.36 and will be deleted in 3.51, use onUserPublishStream, onUserPublishScreen, onUserUnpublishStream and onUserUnpublishScreen instead.

房间内用户暂停/恢复发送视频流时，房间内其他用户会收到此回调。

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onAudioPlaybackDeviceChanged(AudioPlaybackDevice device)
java

Deprecated since 3.38 and will be deleted in 3.51, use onAudioRouteChanged instead.

音频播放设备变化时，收到该回调。

传入参数

注意

音频设备设置与音频路由策略，详见 setAudioPlaybackDevice

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onMediaDeviceStateChanged(
    String deviceID,
    int deviceType,
    int deviceState,
    int deviceError
)
java

Deprecated since 3.37 and will be deleted in 3.51, using onAudioDeviceStateChanged and onVideoDeviceStateChanged instead.

媒体设备状态回调。提示音频采集、音频播放、摄像头视频采集、屏幕视频采集四种媒体设备的状态。

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onMediaDeviceWarning(
    String deviceID,
    int deviceType,
    int deviceWarning
)
java

Deprecated since 3.37 and will be deleted in 3.51, using onAudioDeviceWarning and onVideoDeviceWarning instead.

媒体设备警告回调。媒体设备包括：音频采集设备、音频渲染设备、和视频采集设备。

传入参数

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

Deprecated since 3.52, will be deleted at 3.57, use onLocalProxyStateChanged instead

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

传入参数

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

Deprecated since 3.52, will be deleted at 3.57, use onLocalProxyStateChanged instead

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

传入参数

void com.ss.bytertc.engine.handler.IRTCVideoEventHandler.onSocks5ProxyState(
    int state,
    String cmd,
    String proxyAddress,
    String localAddress,
    String remoteAddress
)
java

Deprecated since 3.52, will be deleted at 3.57, use onLocalProxyStateChanged instead

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

传入参数

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

Deprecated since 353. Use IMediaPlayerEventHandler and IAudioEffectPlayerEventHandler instead.

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

传入参数

注意

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

• 当调用 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 interface com.ss.bytertc.engine.video.ISnapshotResultCallback
java

截图的回调。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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.IAudioFrameProcessor
java

自定义音频处理器。

注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。

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

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

传入参数

返回值

• 0： 成功。
• < 0： 失败。

注意

• 完成自定义音频处理后，SDK 会对处理后的音频帧进行编码，并传输到远端。此音频处理不会影响软件耳返音频数据。
• 要启用此回调，必须调用 enableAudioProcessor，并在参数中选择本地采集的音频，每 10 ms 收到此回调。

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

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

传入参数

注意

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

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

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

传入参数

注意

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

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

Available since 3.50

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

软件耳返音频中包含通过调用 setVoiceReverbType 和 setVoiceChangerType 设置的音频特效。

传入参数

返回值

• 0： 成功。
• < 0： 失败。

注意

• 此数据处理只影响软件耳返音频数据。
• 要启用此回调，必须调用 enableAudioProcessor，并选择软件耳返音频，每 10 ms 收到此回调。

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

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

传入参数

注意

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