@protocol ByteRTCRoomDelegate <NSObject>
objectivec

房间事件回调接口

- (void)rtcRoom:(ByteRTCRoom *_Nonnull)rtcRoom onRoomStateChanged:(NSString *_Nonnull)roomId withUid:(nonnull NSString *)uid state:(NSInteger)state extraInfo:(NSString *_Nonnull)extraInfo;
objectivec

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

传入参数

- (void)rtcRoom:(ByteRTCRoom *_Nonnull)rtcRoom onStreamStateChanged:(NSString *_Nonnull)roomId withUid:(nonnull NSString *)uid state:(NSInteger)state extraInfo:(NSString *_Nonnull)extraInfo;
objectivec

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onLeaveRoom:(ByteRTCRoomStats *_Nonnull)stats;
objectivec

离开房间成功回调。

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

传入参数

注意

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

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRoomWarning:(ByteRTCWarningCode)warningCode;
objectivec

Deprecated since 3.41 and will be deleted in 3.51, use rtcRoom:onRoomStateChanged:withUid:state:extraInfo: and rtcRoom:onStreamStateChanged:withUid:state:extraInfo: instead.

发生警告回调。

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRoomError:(ByteRTCErrorCode)errorCode;
objectivec

Deprecated since 3.41 and will be deleted in 3.51, use rtcRoom:onRoomStateChanged:withUid:state:extraInfo: and rtcRoom:onStreamStateChanged:withUid:state:extraInfo: instead.

发生错误回调。

SDK 运行时出现了错误。SDK 通常无法自动恢复，应用需要采取行动。

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onAVSyncStateChange:(ByteRTCAVSyncState)state;
objectivec

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRoomStats:(ByteRTCRoomStats *_Nonnull)stats;
objectivec

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

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onLocalStreamStats:(ByteRTCLocalStreamStats *_Nonnull)stats;
objectivec

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

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

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRemoteStreamStats:(ByteRTCRemoteStreamStats *_Nonnull)stats;
objectivec

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

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onUserJoined:(ByteRTCUserInfo *_Nonnull)userInfo elapsed:(NSInteger)elapsed;
objectivec

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

1. 远端用户调用 setUserVisibility: 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。
   
2. 远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。
   
3. 房间内隐身远端用户调用 setUserVisibility: 方法切换至可见时，房间内其他用户将收到该事件。
   
4. 新进房用户会收到进房前已在房内的可见用户的进房回调通知。
   

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onUserLeave:(NSString *_Nonnull)uid reason:(ByteRTCUserOfflineReason)reason;
objectivec

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

传入参数

- (void)onTokenWillExpire:( ByteRTCRoom *_Nonnull)rtcRoom;
objectivec

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

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

注意
若 Token 进房权限过期且未及时更新： + 用户此时尝试进房会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调，提示错误码为 -1000 Token 无效；

• 用户已在房间内则会被移出房间，本地用户会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调，提示错误码为 -1009 Token 过期，同时远端用户会收到 rtcRoom:onUserLeave:reason: 回调，提示原因为 2 Token 进房权限过期。

- (void)onPublishPrivilegeTokenWillExpire:( ByteRTCRoom *_Nonnull)rtcRoom;
objectivec

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

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

注意
若收到该回调后未及时更新 Token，Token 发布权限过期后： + 此时尝试发布流会收到 rtcRoom:onStreamStateChanged:withUid:state:extraInfo: 回调，提示错误码为 -1002 没有发布权限；

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

- (void)onSubscribePrivilegeTokenWillExpire:( ByteRTCRoom *_Nonnull)rtcRoom;
objectivec

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

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

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

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onStreamAdd:(id<ByteRTCStream> _Nonnull)stream;
objectivec

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

以下情况会触发此回调：

• 房间内的用户发布新的音视频流时，房间内的其他用户会收到此回调通知。
  
• 房间内的用户原音视频流被移出后，又重新发布音视频流时，房间内的其他用户会收到此回调通知。
  
• 用户刚加入房间时，会收到此回调，包含房间中所有已发布的流。

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onStreamRemove:(NSString *_Nonnull)uid stream:(id<ByteRTCStream> _Nonnull)stream reason:(ByteRTCStreamRemoveReason)reason;
objectivec

Deprecated since 3.36 and will be deleted in 3.51, use rtcRoom:onUserUnpublishStream:type:reason: and rtcRoom:onUserUnpublishScreen:type:reason: instead.

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

传入参数

- (void)rtcRoom:( ByteRTCRoom * _Nonnull)rtcRoom onUserPublishStream:(NSString *_Nonnull)userId type:(ByteRTCMediaStreamType)type;
objectivec

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

传入参数

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

- (void)rtcRoom:( ByteRTCRoom * _Nonnull)rtcRoom onUserUnpublishStream:(NSString *_Nonnull)userId type:(ByteRTCMediaStreamType)type reason:(ByteRTCStreamRemoveReason)reason;
objectivec

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

传入参数

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

- (void)rtcRoom:( ByteRTCRoom * _Nonnull)rtcRoom onUserPublishScreen:(NSString *_Nonnull)userId type:(ByteRTCMediaStreamType)type;
objectivec

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

传入参数

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

- (void)rtcRoom:( ByteRTCRoom * _Nonnull)rtcRoom onUserUnpublishScreen:(NSString *_Nonnull)userId type:(ByteRTCMediaStreamType)type reason:(ByteRTCStreamRemoveReason)reason;
objectivec

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

传入参数

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

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onStreamSubscribed:(ByteRTCSubscribeState)state userId:(NSString *_Nonnull)userId subscribeConfig:(ByteRTCSubscribeConfig *_Nonnull)info;
objectivec

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

传入参数

注意
本地用户收到该回调的时机包括： + 调用 subscribeStream:mediaStreamType: 或 unsubscribeStream:mediaStreamType: 订阅/取消订阅指定远端摄像头音视频流后；

• 调用 subscribeScreen:mediaStreamType: 或 unsubscribeScreen:mediaStreamType: 订阅/取消订阅指定远端屏幕共享流后。

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRoomMessageReceived:(NSString *_Nonnull)uid message:(NSString *_Nonnull)message;
objectivec

收到房间中调用 sendRoomMessage: 发送的广播文本消息时，收到此回调。

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRoomBinaryMessageReceived:(NSString *_Nonnull)uid message:(NSData *_Nonnull)message;
objectivec

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

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onUserMessageReceived:(NSString *_Nonnull)uid message:(NSString *_Nonnull)message;
objectivec

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onUserBinaryMessageReceived:(NSString *_Nonnull)uid message:(NSData *_Nonnull)message;
objectivec

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onUserMessageSendResult:(NSInteger)msgid error:(ByteRTCUserMessageSendResult)error;
objectivec

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

传入参数

注意

• 你应调用 sendUserMessage:message:config: 向房间内单个用户发送文本消息
• 你应调用 sendUserBinaryMessage:message:config: 向房间内单个用户发送二进制消息

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onRoomMessageSendResult:(NSInteger)msgid error:(ByteRTCRoomMessageSendResult)error;
objectivec

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

传入参数

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onVideoStreamBanned:(NSString *_Nonnull)uid isBanned:(BOOL)banned;
objectivec

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

传入参数

注意

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

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onAudioStreamBanned:(NSString *_Nonnull)uid isBanned:(BOOL)banned;
objectivec

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

传入参数

注意

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

- (void)rtcRoom:( ByteRTCRoom *_Nonnull)rtcRoom onForwardStreamStateChanged:(NSArray<ForwardStreamStateInfo *> * _Nonnull)infos;
objectivec

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

传入参数

- (void)rtcRoom:( ByteRTCRoom * _Nonnull)rtcRoom onForwardStreamEvent:(NSArray<ForwardStreamEventInfo *> * _Nonnull)infos;
objectivec

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

传入参数

- (void)rtcRoom:(ByteRTCRoom * _Nonnull)rtcRoom onNetworkQuality:(ByteRTCNetworkQualityStats *_Nonnull)localQuality remoteQualities:(NSArray<ByteRTCNetworkQualityStats*> *_Nonnull)remoteQualities;
objectivec

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

传入参数

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

@protocol ByteRTCVideoDelegate <NSObject>
objectivec

ByteRTCVideoDelegate 协议包含了SDK提供的回调方法，SDK通过代理向应用程序上报一些运行时事件

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onWarning:(ByteRTCWarningCode)Code;
objectivec

发生警告回调。

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onError:(ByteRTCErrorCode)errorCode;
objectivec

发生错误回调。

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

你可能需要干预.

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onCreateRoomStateChanged:(NSString * _Nonnull)roomId errorCode:(NSInteger)errorCode;
objectivec

创建房间失败回调。

传入参数

- (void) rtcEngine:(ByteRTCVideo * _Nonnull)engine onConnectionStateChanged:(ByteRTCConnectionState) state;
objectivec

SDK 与信令服务器连接状态改变回调。连接状态改变时触发。

传入参数

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

- (void) rtcEngine:(ByteRTCVideo * _Nonnull)engine onNetworkTypeChanged:(ByteRTCNetworkType) type;
objectivec

SDK 当前网络连接类型改变回调。

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserMuteAudio:(NSString * _Nonnull)roomId uid:(NSString * _Nonnull)uid muteState:(ByteRTCMuteState)muteState;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserStartAudioCapture:(NSString* _Nonnull)roomId uid:(NSString *_Nonnull)userId;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserStopAudioCapture:(NSString* _Nonnull)roomId uid:(NSString *_Nonnull)userId;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstRemoteAudioFrame:(ByteRTCRemoteStreamKey * _Nonnull)key;
objectivec

当收到远端流的第一帧音频的时候上报该事件

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onLocalAudioPropertiesReport:(NSArray<ByteRTCLocalAudioPropertiesInfo *> * _Nonnull)audioPropertiesInfos;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onRemoteAudioPropertiesReport:(NSArray<ByteRTCRemoteAudioPropertiesInfo *> * _Nonnull)audioPropertiesInfos totalRemoteVolume:(NSInteger)totalRemoteVolume;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onActiveSpeaker:(NSString * _Nonnull)roomId uid:(NSString *_Nonnull)uid;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserMuteVideo:(NSString * _Nonnull)roomId uid:(NSString * _Nonnull)uid withMuteState:(ByteRTCMuteState)muteState;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserStartVideoCapture:(NSString * _Nonnull)roomId uid:(NSString * _Nonnull)uid;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserStopVideoCapture:(NSString * _Nonnull)roomId uid:(NSString * _Nonnull)uid;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstLocalVideoFrameCaptured:(ByteRTCStreamIndex)streamIndex withFrameInfo:(ByteRTCVideoFrameInfo * _Nonnull)frameInfo;
objectivec

第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时，收到此回调。

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstRemoteVideoFrameRendered:(ByteRTCRemoteStreamKey * _Nonnull)streamKey withFrameInfo:(ByteRTCVideoFrameInfo * _Nonnull)frameInfo;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstRemoteVideoFrameDecoded:(ByteRTCRemoteStreamKey * _Nonnull)streamKey withFrameInfo:(ByteRTCVideoFrameInfo * _Nonnull)frameInfo;
objectivec

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

传入参数

注意

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

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onRemoteVideoSizeChanged:(ByteRTCRemoteStreamKey *_Nonnull)streamKey withFrameInfo:(ByteRTCVideoFrameInfo *_Nonnull)frameInfo;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onLocalVideoSizeChanged:(ByteRTCStreamIndex)streamIndex withFrameInfo:(ByteRTCVideoFrameInfo *_Nonnull)frameInfo;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onMediaDeviceStateChanged:(NSString*_Nonnull)device_id device_type:(ByteRTCMediaDeviceType)device_type device_state:(ByteRTCMediaDeviceState)device_state device_error:(ByteRTCMediaDeviceError)device_error;
objectivec

Deprecated since 3.37 and will be deleted in 3.51, use rtcEngine:onAudioDeviceStateChanged:device_type:device_state:device_error: and rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error: instead.

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onAudioDeviceStateChanged:(NSString*_Nonnull)device_id device_type:(ByteRTCAudioDeviceType)device_type device_state:(ByteRTCMediaDeviceState)device_state device_error:(ByteRTCMediaDeviceError)device_error;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onVideoDeviceStateChanged:(NSString*_Nonnull)device_id device_type:(ByteRTCVideoDeviceType)device_type device_state:(ByteRTCMediaDeviceState)device_state device_error:(ByteRTCMediaDeviceError)device_error;
objectivec

视频设备状态发生改变回调。当设备的视频状态发生改变时，SDK 会触发该回调，提示摄像头视频采集、屏幕视频采集等设备的状态。

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onMediaDeviceWarning:(NSString*_Nonnull)deviceId deviceType:(ByteRTCMediaDeviceType)deviceType deviceWarning:(ByteRTCMediaDeviceWarning)deviceWarning;
objectivec

Deprecated since 3.37 and will be deleted in 3.51, use rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning: and rtcEngine:onVideoDeviceWarning:deviceType:deviceWarning: instead.

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onAudioDeviceWarning:(NSString*_Nonnull)deviceId deviceType:(ByteRTCAudioDeviceType)deviceType deviceWarning:(ByteRTCMediaDeviceWarning)deviceWarning;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onVideoDeviceWarning:(NSString*_Nonnull)deviceId deviceType:(ByteRTCVideoDeviceType)deviceType deviceWarning:(ByteRTCMediaDeviceWarning)deviceWarning;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onAudioFrameSendStateChanged:(NSString * _Nonnull)roomId rtcUser:(ByteRTCUser *_Nonnull)user state:(ByteRTCFirstFrameSendState)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onVideoFrameSendStateChanged:(NSString * _Nonnull)roomId rtcUser:(ByteRTCUser *_Nonnull)user state:(ByteRTCFirstFrameSendState)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onScreenVideoFrameSendStateChanged:(NSString * _Nonnull)roomId rtcUser:(ByteRTCUser *_Nonnull)user state:(ByteRTCFirstFrameSendState)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onAudioFramePlayStateChanged:(NSString * _Nonnull)roomId rtcUser:(ByteRTCUser *_Nonnull)user state:(ByteRTCFirstFramePlayState)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onVideoFramePlayStateChanged:(NSString * _Nonnull)roomId rtcUser:(ByteRTCUser *_Nonnull)user state:(ByteRTCFirstFramePlayState)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onScreenVideoFramePlayStateChanged:(NSString * _Nonnull)roomId rtcUser:(ByteRTCUser *_Nonnull)user state:(ByteRTCFirstFramePlayState)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstLocalAudioFrame:(ByteRTCStreamIndex) streamIndex;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onAudioPlaybackDeviceChanged:(ByteRTCAudioPlaybackDevice)device;
objectivec

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

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onAudioRouteChanged:(ByteRTCAudioRoute)device;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onSEIMessageReceived:(ByteRTCRemoteStreamKey* _Nonnull)remoteStreamKey andMessage:(NSData* _Nonnull)message;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onSEIStreamUpdate:(ByteRTCRemoteStreamKey* _Nonnull)remoteStreamKey eventType:(ByteSEIStreamEventType)eventType;
objectivec

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

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onStreamSyncInfoReceived:(ByteRTCRemoteStreamKey* _Nonnull)remoteStreamKey streamType:(ByteRTCSyncInfoStreamType)streamType data:(NSData* _Nonnull)data;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onSysStats:(const ByteRTCSysStats * _Nonnull)stats;
objectivec

报告当前设备 cpu 与 memory 使用率，每 2s 触发一次。

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onLocalAudioStateChanged:(ByteRTCLocalAudioStreamState)state error:(ByteRTCLocalAudioStreamError)error;
objectivec

Deprecated since 3.50 and will be deleted in 3.55. Use rtcEngine:onAudioDeviceStateChanged:device_type:device_state:device_error: instead.

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onRemoteAudioStateChanged:(ByteRTCRemoteStreamKey * _Nonnull)key state:(ByteRTCRemoteAudioState)state reason:(ByteRTCRemoteAudioStateChangeReason)reason;
objectivec

订阅的远端音频流状态发生改变时，收到此回调。

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onLocalVideoStateChanged:(ByteRTCStreamIndex)streamIndex withStreamState:(ByteRTCLocalVideoStreamState)state withStreamError:(ByteRTCLocalVideoStreamError)error;
objectivec

Deprecated since 3.50 and will be deleted in 3.55. Use rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error: instead.

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onRemoteVideoStateChanged:(ByteRTCRemoteStreamKey*_Nonnull)streamKey withVideoState:(ByteRTCRemoteVideoState)state withVideoStateReason:(ByteRTCRemoteVideoStateChangeReason)reason;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onLoginResult:(NSString * _Nonnull)uid errorCode:(ByteRTCLoginErrorCode)errorCode elapsed:(NSInteger)elapsed;
objectivec

登录结果回调

传入参数

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

- (void)rtcEngineOnLogout:(ByteRTCVideo * _Nonnull)engine;
objectivec

登出结果回调

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onServerParamsSetResult:(NSInteger)errorCode;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onGetPeerOnlineStatus:(NSString * _Nonnull)peerUserId status:(ByteRTCUserOnlineStatus)status;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserMessageReceivedOutsideRoom:(NSString * _Nonnull)uid message:(NSString * _Nonnull)message;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserBinaryMessageReceivedOutsideRoom:(NSString * _Nonnull)uid message:(NSData * _Nonnull)message;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onUserMessageSendResultOutsideRoom:(NSInteger)msgid error:(ByteRTCUserMessageSendResult)error;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onServerMessageSendResult:(int64_t)msgid error:(ByteRTCUserMessageSendResult)error message:(NSData * _Nonnull)message;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onNetworkDetectionResult:(ByteRTCNetworkDetectionLinkType)type quality:(ByteRTCNetworkQuality)quality rtt:(int)rtt lostRate:(double)lost_rate bitrate:(int)bitrate jitter:(int)jitter;
objectivec

通话前网络探测结果的回调。

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onNetworkDetectionStopped:(ByteRTCNetworkDetectionStopReason)err_code;
objectivec

通话前网络探测结束

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo* _Nonnull)engine log:(NSDictionary* _Nonnull)dict;
objectivec

Deprecated since 3.45 and will be deleted in 3.51.

SDK 内部日志回调。

SDK 内部运行时，会把日志回调给业务方，方便排查问题。

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onAudioMixingStateChanged:(NSInteger)mixId state:(ByteRTCAudioMixingState)state error:(ByteRTCAudioMixingError)error;
objectivec

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

传入参数

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

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onAudioMixingPlayingProgress:(NSInteger)mixId progress:(int64_t) progress;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onPerformanceAlarms:(ByteRTCPerformanceAlarmMode)mode roomId:(NSString *_Nonnull)roomId reason:(ByteRTCPerformanceAlarmReason)reason sourceWantedData:(ByteRTCSourceWantedData *_Nonnull)data;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onSimulcastSubscribeFallback:(ByteRTCRemoteStreamSwitchEvent *_Nonnull)event;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onHttpProxyState:(NSInteger)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onHttpsProxyState:(NSInteger)state;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onSocks5ProxyState:(NSInteger)state cmd:(NSString *_Nonnull)cmd proxy_address:(NSString *_Nonnull)proxy_address local_address:(NSString *_Nonnull)local_address remote_address:(NSString *_Nonnull)remote_address;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo* _Nonnull)engine onRecordingStateUpdate:(ByteRTCStreamIndex)type state:(ByteRTCRecordingState)state error_code:(ByteRTCRecordingErrorCode)error_code recording_info:(ByteRTCRecordingInfo* _Nonnull)recording_info;
objectivec

获取本地录制状态回调。

该回调由 startFileRecording:withRecordingConfig:type: 或 stopFileRecording: 触发。

传入参数

- (void)rtcEngine:(ByteRTCVideo* _Nonnull)engine onRecordingProgressUpdate:(ByteRTCStreamIndex)type process:(ByteRTCRecordingProgress* _Nonnull)process recording_info:(ByteRTCRecordingInfo* _Nonnull)recording_info;
objectivec

本地录制进度回调。

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

传入参数

- (void)rtcEngine:(ByteRTCVideo* _Nonnull)engine onAudioRecordingStateUpdate:(ByteRTCAudioRecordingState)state error_code:(ByteRTCAudioRecordingErrorCode)error_code;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onPushPublicStreamResult:(NSString *_Nonnull)roomId publicStreamId:(NSString *_Nonnull)streamId errorCode:(ByteRTCPublicStreamErrorCode)errorCode;
objectivec

公共流发布结果回调。

调用 startPushPublicStream:withLayout:

接口或直接在服务端启动推公共流功能后，你会通过此回调收到启动结果和推流过程中的错误。

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onPlayPublicStreamResult:(NSString *_Nonnull)publicStreamId errorCode:(ByteRTCPublicStreamErrorCode)errorCode;
objectivec

订阅公共流的结果回调

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onPublicStreamSEIMessageReceived:(NSString* _Nonnull)publicStreamId andMessage:(NSData* _Nonnull)message andSourceType:(ByteRTCSEIMessageSourceType)sourceType;
objectivec

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

传入参数

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

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstPublicStreamVideoFrameDecoded:(NSString * _Nonnull)publicStreamId withFrameInfo:(ByteRTCVideoFrameInfo * _Nonnull)frameInfo;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onFirstPublicStreamAudioFrame:(NSString * _Nonnull)publicStreamId;
objectivec

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

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onCloudProxyConnected:(NSInteger)interval;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo *_Nonnull)engine onEchoTestResult:(ByteRTCEchoTestResult)result;
objectivec

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

传入参数

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

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

- (void)rtcEngineOnNetworkTimeSynchronized:(ByteRTCVideo *_Nonnull)engine;
objectivec

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

传入参数

- (void)rtcEngine:(ByteRTCVideo * _Nonnull)engine onLicenseWillExpire:(NSInteger)days;
objectivec

license过期时间提醒

传入参数

@protocol ByteRTCAudioFrameObserver <NSObject>
objectivec

音频数据回调观察者
注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。
本接口类中的回调周期均为 20 ms。

- (void)onRecordAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

- (void)onPlaybackAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

- (void)onRemoteUserAudioFrame:(ByteRTCRemoteStreamKey * _Nonnull)streamKey audioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

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

- (void)onMixedAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

@protocol ByteRTCAudioProcessor <NSObject>
objectivec

自定义音频处理器

- (int)processAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

获取 RTC SDK 采集得到的音频帧，并进行自定义处理，最终将处理后的音频帧给到 RTC SDK 用于编码传输。

传入参数

返回值

0: 未处理
>0: 处理成功
< 0: 处理失败

注意
在进行音频自定义处理前，你需要调用 registerLocalAudioProcessor 设置音频自定义处理器。

@protocol ByteRTCAudioFrameProcessor <NSObject>
objectivec

自定义音频处理器

- (int)onProcessRecordAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

注意

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

- (int)onProcessPlayBackAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

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

- (int)onProcessRemoteUserAudioFrame:(ByteRTCRemoteStreamKey * _Nonnull)stream_info audioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

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

- (int)onProcessEarMonitorAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

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

传入参数

注意

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

- (int)onProcessScreenAudioFrame:(ByteRTCAudioFrame * _Nonnull)audioFrame;
objectivec

回调屏幕共享的音频帧地址，供自定义音频处理。

传入参数

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

@protocol ByteRTCASREngineEventHandler<NSObject>
objectivec

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

- (void)onSuccess;
objectivec

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

- (void)onMessage:(NSString *_Nonnull)message;
objectivec

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

传入参数

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

- (void)onError:(NSInteger)errorCode withErrorMessage:(NSString *_Nonnull)errorMessage;
objectivec

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

传入参数

@protocol ByteRTCAudioFileFrameObserver <NSObject>
objectivec

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

- (void)onAudioFileFrame:(int)mix_id audioFrame:(ByteRTCAudioFrame * _Nonnull)audio_frame;
objectivec

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

传入参数

@protocol ByteRTCEncryptHandler <NSObject>
objectivec

自定义加密接口

- (NSData * _Nonnull) onEncryptData:(NSData * _Nonnull)rawData;
objectivec

自定义加密。

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

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

传入参数

返回值
加密后的数据

• 非空，表示加密后的数据
• 为空，表示数据被丢弃

注意

• 使用此接口进行自定义加密前，你必须先设置自定义加密方式，参看 setCustomizeEncryptHandler:。
• 使用 onDecryptData: 对已加密的音视频帧数据进行解密。
• 返回的数据大小应控制在原始数据的 90% ~ 120% 范围以内，不然将被丢弃。

- (NSData * _Nonnull) onDecryptData:(NSData * _Nonnull)rawData;
objectivec

自定义解密。

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

传入参数

返回值
解密后的数据

• 非空，表示解密后的数据
• 为空，表示丢弃该帧

注意

• 使用此接口进行解密前，你必须先设定解密方式，参看 setCustomizeEncryptHandler:。
• 返回的数据大小应控制在原始数据的 90% ~ 120% 范围以内，不然将被丢弃。

@protocol ByteRTCKTVManagerDelegate <NSObject>
objectivec

KTV 事件回调接口。

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onMusicListResult:(ByteRTCKTVError)errorCode totalSize:(int)totalSize musics:(NSArray<ByteRTCKTVMusic *> * _Nullable)musics;
objectivec

歌曲列表回调。

传入参数

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onSearchMusicResult:(ByteRTCKTVError)errorCode totalSize:(int)totalSize musics:(NSArray<ByteRTCKTVMusic *> * _Nullable)musics;
objectivec

搜索歌曲结果回调。

传入参数

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onHotMusicResult:(ByteRTCKTVError)errorCode hotMusicInfos:(NSArray<ByteRTCKTVHotMusicInfo *> * _Nullable)hotMusicInfos;
objectivec

热榜歌曲结果回调。

传入参数

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onMusicDetailResult:(ByteRTCKTVError)errorCode music:(ByteRTCKTVMusic * _Nullable)music;
objectivec

歌曲详细信息回调。

传入参数

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onDownloadSuccess:(int)downloadId downloadResult:(ByteRTCKTVDownloadResult *)result;
objectivec

下载成功回调。

传入参数

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onDownloadFail:(int)downloadId errorCode:(ByteRTCKTVError)errorCode;
objectivec

下载失败回调。

传入参数

- (void)ktvManager:(ByteRTCKTVManager *)ktvManager onDownloadMusicProgress:(int)downloadId progress:(int)downloadPercentage;
objectivec

歌曲文件下载进度回调。

传入参数

@protocol ByteRTCKTVPlayerDelegate <NSObject>
objectivec

KTV 播放器回调接口。

- (void)ktvPlayer:(ByteRTCKTVPlayer *)ktvPlayer onPlayProgress:(NSString *)musicId progress:(int64_t)progress;
objectivec

音乐播放进度回调。

传入参数

- (void)ktvPlayer:(ByteRTCKTVPlayer *)ktvPlayer onPlayStateChange:(NSString *)musicId state:(ByteRTCKTVPlayState)state error:(ByteRTCKTVPlayerError)error;
objectivec

音乐播放状态改变回调。

传入参数

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

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

@protocol ByteRtcScreenCapturerExtDelegate <NSObject>
objectivec

屏幕采集相关扩展协议，仅适用于 SDK 内部采集。

用户创建 extension 后生成的 SampleHandler 需继承此协议以实现屏幕共享相关能力。

- (void)onQuitFromApp;
objectivec

通知 Broadcast Upload Extension 停止采集屏幕并退出。

注意
用户调用 stopScreenCapture 后，会触发该方法通知 extension 端的 SDK 停止屏幕采集。

- (void)onReceiveMessageFromApp:(NSData *)message;
objectivec

Socket 收到 App 侧发来的信息时，触发该回调

传入参数

- (void)onSocketDisconnect;
objectivec

Socket 连接断开时触发此回调

- (void)onSocketConnect;
objectivec

Socket 连接成功时触发此回调

- (void)onNotifyAppRunning;
objectivec

检测到 App 正在进行音视频通话时触发此回调。

@protocol ByteRTCSingScoringDelegate<NSObject>
objectivec

K 歌评分事件回调类。

- (void)onCurrentScoringInfo:(ByteRTCSingScoringRealtimeInfo * _Nullable)info;
objectivec

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

传入参数

@protocol ByteRTCVideoProcessorDelegate <NSObject>
objectivec

- (ByteRTCVideoFrame* _Nullable)processVideoFrame:(ByteRTCVideoFrame* _Nonnull)src_frame;
objectivec

获取 RTC SDK 采集得到的视频帧，根据 registerLocalVideoProcessor:withConfig: 设置的视频前处理器，进行视频前处理，最终将处理后的视频帧给到 RTC SDK 用于编码传输。

传入参数

返回值
经过视频前处理后的视频帧，返回给 RTC SDK 供编码和传输，参考: ByteRTCVideoFrame

注意
如果需要取消视频前处理，可以将视频前处理器设置为 nullptr。

@protocol ByteRTCLocalEncodedVideoFrameObserver<NSObject>
objectivec

本地视频帧监测器

- (void)onLocalEncodedVideoFrame:(ByteRTCStreamIndex) streamIndex Frame:(ByteRTCEncodedVideoFrame * _Null_unspecified)frame;
objectivec

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

传入参数

@protocol ByteRTCExternalVideoEncoderEventHandler<NSObject>
objectivec

自定义编码帧回调类

- (void)onStart:(ByteRTCStreamIndex)streamIndex;
objectivec

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

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

传入参数

- (void)onStop:(ByteRTCStreamIndex)streamIndex;
objectivec

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

传入参数

- (void)onRateUpdate:(ByteRTCStreamIndex)streamIndex withVideoIndex:(NSInteger)videoIndex withFps:(NSInteger)fps withBitRate:(NSInteger)bitRateKps;
objectivec

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

传入参数

- (void)onRequestKeyFrame:(ByteRTCStreamIndex)streamIndex withVideoIndex:(NSInteger)videoIndex;
objectivec

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

传入参数

@protocol ByteRTCRemoteEncodedVideoFrameObserver<NSObject>
objectivec

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

- (void)onRemoteEncodedVideoFrame:(ByteRTCRemoteStreamKey * _Nonnull)streamKey withEncodedVideoFrame:(ByteRTCEncodedVideoFrame* _Nonnull)videoFrame;
objectivec

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

传入参数

@protocol LiveTranscodingDelegate <NSObject>
objectivec

转推直播观察者。

- (BOOL)isSupportClientPushStream;
objectivec

是否具有推流能力。

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

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

- (void)onStreamMixingEvent:(ByteRTCStreamMixingEvent)event taskId:(NSString *_Nonnull)taskId error:(ByteRtcTranscoderErrorCode)Code mixType:(ByteRTCStreamMixingType)mixType;
objectivec

转推直播状态回调

传入参数

- (void)onMixingAudioFrame:(ByteRTCAudioFrame *_Nonnull)audioFrame timestamp:(int64_t)timeStamp taskId:(NSString *_Nonnull)taskId;
objectivec

端云一体合流音频 PCM 回调

传入参数

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

- (void)onMixingVideoFrame:(ByteRTCVideoFrame *_Nonnull)videoFrame taskId:(NSString *_Nonnull)taskId;
objectivec

端云一体合流视频 YUV 回调

传入参数

注意
收到该回调的周期取决于视频的帧率。

- (void)onMixingDataFrame:(ByteRTCFrameExtendedData *_Nonnull)dataFrame taskId:(NSString *_Nonnull)taskId;
objectivec

端云一体合流视频 SEI 数据

传入参数

@protocol ByteRTCPushSingleStreamToCDNObserver <NSObject>
objectivec

单流转推直播观察者。

- (void)onStreamPushEvent:(ByteRTCSingleStreamPushEvent)event taskId:(NSString *_Nonnull)taskId error:(NSInteger)Code;
objectivec

单流转推直播状态回调

传入参数

@protocol ByteRTCFaceDetectionObserver <NSObject>
objectivec

人脸检测结果回调观察者

- (void)onFaceDetectResult:(ByteRTCFaceDetectionResult * _Nonnull)result;
objectivec

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

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

传入参数

@protocol ByteRTCVideoSnapshotCallbackDelegate <NSObject>
objectivec

- (void)onTakeLocalSnapshotResult:(NSInteger) taskId streamIndex:(ByteRTCStreamIndex)streamIndex image:(ByteRTCImage * _Nullable)image errorCode:(NSInteger)errorCode;
objectivec

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

传入参数

- (void)onTakeRemoteSnapshotResult:(NSInteger)taskId streamKey:(ByteRTCRemoteStreamKey * _Nonnull)streamKey image:(ByteRTCImage * _Nullable)image errorCode:(NSInteger)errorCode;
objectivec

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

传入参数