事件回调（HWRtcEngine）

onJoinSuccess

-(void)onJoinSuccess:(NSString*)roomId userId:(NSString*)userId;

【功能说明】

成功加入房间，触发此回调。

onJoinRoomFailure

 - (void)onJoinRoomFailure:(int)errorCode errorMsg:(NSString * _Nonnull)errorMsg;

【功能说明】

加入房间失败，触发此回调。

• errorMsg：错误信息描述。

onRejoinRoomSuccess

- (void)onRejoinRoomSuccess:(NSString *)roomid userid:(NSString *)userid;

【功能说明】

重新加入房间回调。例如网络异常后重连成功加入房间触发。

onLeaveRoom

- (void)onLeaveRoom:(HWRtcLeaveReason)leaveReason statsInfo:(HWRtcStatsInfo *)statsInfo;

【功能说明】

离开房间，触发此回调。

APP调用leaveRoom接口时，会返回HWRtcLeaveReasonUserLeaveRoom，APP可以通过以下任一方式回退到登录界面。

• APP在调用leaveRoom接口时退到登录界面，或者在收到到onLeaveRoom回调，且回调消息不等于HWRtcLeaveReasonUserLeaveRoom时（防止重复操作），退到登录界面。
• APP只在收到onLeaveRoom消息时退到登录界面。

onRemoteUserOnline

- (void)onRemoteUserOnline:(NSString*)roomId userId:(NSString*)userId userName:(NSString*)userName;

【功能说明】

远端用户加入房间成功，触发此回调。该回调提示有远端用户加入了房间，并返回新加入用户信息。

【回调参数】

• roomId：房间ID。
• userId：远端用户ID。
• userName：远端用户昵称。

onRemoteUserOffline

- (void)onRemoteUserOffline:(NSString*)roomId userId:(NSString*)userId reason:(NSInteger)reason;

【功能说明】

远端用户离开当前房间，触发此回调。

本端用户离开当前房间，会回调当前房间所有用户offline。

onUserNameChangedNotify

 -(void)onUserNameChangedNotify:(NSString * _Nonnull)oldUserName newUserName:(NSString * _Nonnull)newUserName;

【功能说明】

本端用户昵称变化，触发此回调。

【回调参数】

• oldUserName：变更前的昵称。
• newUserName：变更后的昵称。

onRemoteUserNameChangedNotify

-(void)onRemoteUserNameChangedNotify:(NSString * _Nonnull)roomId userId:(NSString * _Nonnull)userId userName:(NSString * _Nonnull)userName;

【功能说明】

远端用户昵称变化，触发此回调。

【回调参数】

• roomId：房间ID。
• userId：用户ID。
• userName：昵称。

onFirstRemoteVideoDecoded

- (void)onFirstRemoteVideoDecoded:(NSString*)roomId userId:(NSString*)userId width:(int)width height:(int)height;

【功能说明】

引擎收到第一帧远端视频流并解码成功回调。

onFirstRemoteVideoDecoded

- (void)onFirstRemoteVideoDecoded:(NSString*)roomId userId:(NSString*)userId width:(int)width height:(int)height elapsed:(NSUInteger)elapsed;

【功能说明】

引擎收到第一帧远端视频流并解码成功回调。

onFirstRemoteAuxiliaryStreamDecoded

- (void)onFirstRemoteAuxiliaryStreamDecoded:(NSString*)roomId userId:(NSString*)userId width:(int)width height:(int)height;

【功能说明】

引擎收到第一帧远端视频流并解码成功回调。

onFirstRemoteAuxiliaryStreamDecoded

- (void)onFirstRemoteAuxiliaryStreamDecoded:(NSString*)roomId userId:(NSString*)userId width:(int)width height:(int)height elapsed:(NSUInteger)elapsed;

【功能说明】

引擎收到第一帧远端视频流并解码成功回调。

onUserRoleChangedNotify

- (void)onUserRoleChangedNotify:(HWRtcRole)oldRole newRole:(HWRtcRole)newRole;

【功能说明】

用户房间内角色切换成功，触发此回调。

onConnectionChangedNotify

- (void)onConnectionChangedNotify:(HWRtcConnStateType)state reason:(HWRtcConnChangeReason)reason description:(NSString*)description;

【功能说明】

网络连接状态发生变化，触发此回调。

onError

- (void)onError:(NSString*)errorCode errorMsg:(NSString*)errorMsg;

【功能说明】

发生错误，触发此回调。返回客户端错误码或者服务端错误码。

onWarning

- (void)onWarning:(int)warningCode warningMsg:(NSString * _Nonnull)warningMsg;

【功能说明】

发生错误，触发此回调。返回客户端错误码或者服务端错误码。

onAuthorizationExpired

- (void)onAuthorizationExpired;

【功能说明】

鉴权签名过期回调，需要app调用renewAuthorization更新签名。

onDeviceStateChangedNotify

- (void)onDeviceStateChangedNotify:(NSString*)deviceId deviceType:(HWRtcDeviceType)deviceType deviceState:(HWRtcDeviceState)deviceState;

【功能说明】

设备状态发生变化，触发此回调。

仅支持macOS。

onAudioVolumeChanged

- (void)onAudioVolumeChanged:(HWRtcDeviceType)deviceType volume:(unsigned int)volume;

【功能说明】

音频设备音量发生变化，触发此回调。

仅支持macOS。

onLocalVolumeChangedNotify

- (void)onLocalVolumeChangedNotify:(int)volume muted:(int)muted;

【功能说明】

本地音频采集音量。

【回调参数】

• volume：音量。
• muted：0表示开启本地音频发送，1表示关闭本地音频发送。

onLocalAudioMutedStatusDetected

- (void)onLocalAudioMutedStatusDetected;

【功能说明】

本地静音但检测到音频输入回调。

【回调参数】

无

通过setVolumeNotifyInterval开启并设置回调周期，本端禁音后检测到麦克风有输入后定时上报。上报频率和setVolumeNotifyInterval的参数大小有关，参考值建议设置成200。

onFirstLocalAudioFrameNotify

- (void)onFirstLocalAudioFrameNotify: (NSUInteger)elapsed;

【功能说明】

本地音频首帧发送回调。

【回调参数】

elapsed：从入会到本地音频首帧发送所用的时间，单位ms。

onFirstLocalVideoFrameNotify

- (void)onFirstLocalVideoFrameNotify:(NSUInteger)elapsed;

【功能说明】

本地视频首帧渲染回调。

【回调参数】

elapsed：从开始采集到本地视频首帧渲染所用的时间，单位ms。

onAudioRouteChange

- (void)onAudioRouteChange:(HWRtcAudioRoute)audioRoute;

【功能说明】

音频路由发生改变，触发此回调。如房间内插拔耳机触发此回调。

【回调参数】

audioRoute：音频路由类型，具体请参见HWRtcAudioRoute。

仅支持iOS。

onLogUploadResult

- (void)onLogUploadResult:(int)result;

【功能说明】

日志上传结果回调。

【回调参数】

result：日志上传结果。

• 0：上传成功。
• 1：上传失败。

onLogUploadProgress

- (void)onLogUploadProgress:(int)progress;

【功能说明】

日志上传进度回调。

【回调参数】

progress：日志上传进度，取值范围0-100。

onRemoteAudioStateChange

- (void)onRemoteAudioStateChange:(NSString * _Nonnull)roomid userid:(NSString * _Nonnull)userid state:(HWRtcRemoteAudioState)state reason:(HWRtcRemoteAudioStateReason)reason;

【功能说明】

远端用户音频流状态发生改变，会触发此回调。

onRemoteVideoStateChange

- (void)onRemoteVideoStateChange:(NSString * _Nonnull)roomid userid:(NSString * _Nonnull)userid state:(HWRtcRemoteVideoState)state reason:(HWRtcRemoteVideoStateReason)reason;

【功能说明】

远端用户视频流状态发生改变，会触发此回调。

onUserVolumeStatsNotify

- (void)onUserVolumeStatsNotify:(NSArray <HWRtcMediaUsersVolumeInfo *> *_Nullable)usersVolumeArray  userNumber:(NSUInteger)userNumber totalVolume:(NSUInteger)totalVolume;

【功能说明】

用户音量状态回调。通过setVolumeNotifyInterval开启并设置回调周期，定时上报。

onRenderExternalVideoFrame

- (void)onRenderExternalVideoFrame:(NSString *_Nonnull)roomid meidaDirection:(HWRtcMediaDirection)meidaDirection videoFrame:(HWRtcVideoFrame * _Nonnull)videoFrame;

【功能说明】

渲染视频帧回调。需要调用setExternalVideoFrameOutputWithFormat接口开启视频自渲染，从而触发该回调。

onPlaybackExternalAudioFrame

- (void)onPlaybackExternalAudioFrame:(NSString *_Nonnull)roomid meidaDirection:(HWRtcMediaDirection)meidaDirection audioFrame:(HWRtcAudioFrame * _Nonnull)audioFrame;

【功能说明】

音频自渲染回调。需要调用setExternalMediaFrameOutput接口开启音频自渲染，从而触发该回调。

onNetworkTestResult

- (void)onNetworkTestResult:(HWRtcNetworkTestResult * _Nonnull)result;

【功能说明】

加房间前网络探测结果回调。

【回调参数】

HWRtcNetworkTestResult：回调状态主要包括测试成功与否、上行和下行的网络带宽、丢包、延时和抖动，具体请参见HWRtcNetworkTestResult。

onNetworkTestQuality

- (void)onNetworkTestQuality:(int)level;

【功能说明】

加房间前网络探测回调。

【回调参数】

level：检测网络质量 ，具体请参见HWRtcNetworkQualityLevel。

onVideoStatsNotify

- (void)onVideoStatsNotify:(NSArray <HWRtcVideoStatsInfo *> * _Nullable)videoStatsArray remoteVideoInfo:(NSArray <HWRtcVideoStatsInfo *>* _Nullable)remoteVideoStatsInfos;

【功能说明】

视频流详情，2s触发一次回调。

只有本地一个用户入会时，不回调该方法。

onAudioStatsNotify

- (void)onAudioStatsNotify:(NSArray <HWRtcAudioStatsInfo *> * _Nullable)audioStatsArray remoteAudioInfo:(NSArray <HWRtcAudioStatsInfo *> * _Nullable)remoteAudioStatsInfos;

【功能说明】

音频流详情，2s触发一次回调。

【回调参数】

• audioStatsArray：本地音频发流详情，具体请参见HWRtcAudioStatsInfo。
• remoteAudioStatsInfos：远端音频收流详情，具体请参见HWRtcAudioStatsInfo。

onAuxiliaryStreamStatsNotify

- (void)onAuxiliaryStreamStatsNotify:(NSArray <HWRtcVideoStatsInfo *> * _Nullable)subStreamStatsArray remoteVideoInfo:(NSArray <HWRtcVideoStatsInfo *> * _Nullable)remoteVideoStatsInfos;

【功能说明】

辅流详情，2s触发一次回调。

【回调参数】

• subStreamStatsArray：本地辅流发流详情，具体请参见HWRtcVideoStatsInfo。
• remoteVideoStatsInfos：远端辅流收流详情，具体请参见HWRtcVideoStatsInfo。

onUserAuxiliaryStreamAvailable

- (void)onUserAuxiliaryStreamAvailable:(NSString * _Nonnull)roomId userId:(NSString * _Nonnull)userId isAvailable:(BOOL)isAvailable;

【功能说明】

辅流状态回调。

【回调参数】

• roomId：房间ID。
• userId：远端用户ID。
• isAvailable：YES表示辅流推送中，NO表示辅流停止推送。

onAudioDeviceTestVolumeNotify

- (void)onAudioDeviceTestVolumeNotify:(HWRtcAudioDeviceTestVolumeNotify * _Nonnull)result;

【功能说明】

本地音频采集音量回调。

【回调参数】

result：本地音频采集音量结果， 具体请参见HWRtcAudioDeviceTestVolumeNotify。

onRenderSuccessNotify

- (void)onRenderSuccessNotify:(NSString *_Nonnull)userid isAux:(NSUInteger)isAux;

【功能说明】

用户视频流渲染成功通知回调。首帧渲染成功、分辨率变化或视频流中断后恢复触发。

【回调参数】

• userId：用户ID。
• isAux：YES表示是辅流，NO表示不是辅流。

onLocalAudioStateChangedNotify

-(void)onLocalAudioStateChangedNotify:(HWRtcLocalAudioState)state
                         reason:(HWRtcLocalAudioStateReason)reason;

【功能说明】

本地音频流状态变化回调。

【回调参数】

• state：本地音频流状态。具体请参见 HWRtcLocalAudioState。
• reason：本地音频流状态变化原因。具体请参见 HWRtcLocalAudioStateReason。

onLocalVideoStateChangedNotify

-(void)onLocalVideoStateChangedNotify:(HWRtcLocalVideoState)state
                         reason:(HWRtcLocalVideoStateReason)reason;

【功能说明】

本地视频流状态变化回调。

【回调参数】

• state：本地视频流状态。具体请参见HWRtcLocalVideoState。
• reason：本地视频流状态变化原因。具体请参见HWRtcLocalVideoStateReason。

onNetworkQualityNotify

- (void)onNetworkQualityNotify:(NSArray <HWRtcQualityInfo *> * _Nullable)upStreamQualityArray
       downStreamQualityInfo:(NSArray <HWRtcQualityInfo *> * _Nullable)downStreamQualityArray;

【功能说明】

房间内客户端基于流级别的网络质量实时上报，默认开启，每2s上报一次，有数据流时才会回调，音频流、视频流分开回调。

【回调参数】

• upStreamQualityArray：上行网络质量状态。具体请参见HWRtcQualityInfo。
• downStreamQualityArray：下行网络质量状态。具体请参见HWRtcQualityInfo。

onLocalVideoStatsNotify

- (void)onLocalVideoStatsNotify:(NSArray <HWRtcLocalVideoStats *> * _Nullable)localVideoStatsArray;

【功能说明】

本端视频流详情，2s触发一次回调。

【回调参数】

localVideoStatsArray：本地视频发流详情参数，具体请参见HWRtcLocalVideoStats。

onRemoteVideoStatsNotify

- (void)onRemoteVideoStatsNotify:(NSArray <HWRtcRemoteVideoStats *> * _Nullable)remoteVideoStatsArray;

【功能说明】

远端视频流详情，2s触发一次回调。

【回调参数】

remoteVideoStatsArray：远端视频收流详情参数，具体请参见HWRtcRemoteVideoStats。

onLocalAudioStatsNotify

- (void)onLocalAudioStatsNotify:(NSArray <HWRtcLocalAudioStats *> * _Nullable)localAudioStatsArray;

【功能说明】

本端音频流详情，2s触发一次回调。

【回调参数】

localAudioStatsArray：本地音频发流详情，具体请参见HWRtcLocalAudioStats。

onRemoteAudioStatsNotify

- (void)onRemoteAudioStatsNotify:(NSArray <HWRtcRemoteAudioStats *> * _Nullable)remoteAudioStatsArray;

【功能说明】

远端音频流详情，2s触发一次回调。

【回调参数】

remoteAudioStatsArray：远端音频收流详情，具体请参见HWRtcRemoteAudioStats。

onRemoteVideoResolutionChangedNotify

- (void)onRemoteVideoResolutionChangedNotify:(NSString *_Nullable)userId width:(NSInteger)width height:(NSInteger)height;

【功能说明】

远端视频大小改变回调。

【回调参数】

• userId：用户ID。
• width：视频流宽度。
• height：视频流高度。

onStatsNotify

- (void)onStatsNotify:(NSArray <HRTCOnStats*> * _Nullable)rtcStatsArray;

【功能说明】

当前会话统计回调。

回调参数

hrtcOnStats：会话统计信息，具体请参见HRTCOnStats。

onAudioMixStateChangedNotify

- (void)onAudioMixStateChangedNotify:(HWRtcAudioFileState)state reason:(HWRtcAudioFileReason)reason value:(NSUInteger)value;

【功能说明】

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

onAudioClipFinished

- (void)onAudioClipFinished:(NSInteger)soundId;

【功能说明】

音效文件播放结束回调。

回调参数

soundId：音效ID，取值>= 0。

onSeiSendMsgSuccess

- (void)onSeiSendMsgSuccess:(NSString * _Nonnull)message;

【功能说明】

发送音频SEI消息成功。

回调参数

message：本人发送成功的消息内容。

onSeiRecvMsg

- (void)onSeiRecvMsg:(NSString * _Nonnull)userId message:(NSString * _Nonnull)message

【功能说明】

收到userId用户的音频SEI消息。

onStartPublishStream

- (void)onStartPublishStream:(NSInteger)code taskId:(NSString *_Nonnull)taskId;

【功能说明】

开始旁路（RTMP）推流回调。

【回调参数】

• code：错误码，成功为0，失败请参见HWRtcErrorCode。
• taskId：任务Id。

onUpdateTransCoding

- (void)onUpdateTransCoding:(NSInteger)code taskId:(NSString *_Nonnull)taskId;

【功能说明】

更新旁路（RTMP）推流消息。

【回调参数】

• code：错误码，成功为0，失败请参见HWRtcErrorCode。
• taskId：任务Id。

onStopPublishStream

- (void)onStopPublishStream:(NSInteger)code taskId:(NSString *_Nonnull)taskId;

【功能说明】

停止旁路（RTMP）推流消息。

【回调参数】

• code：错误码，成功为0，失败请参见HWRtcErrorCode。
• taskId：任务Id。

onStreamPublishStateChange

- (void)onStreamPublishStateChange:(NSInteger)code taskId:(NSString *_Nonnull)taskId urlStatus:(NSArray <HRTCRtmpUrlInfoModel *> * _Nullable)urlList;

【功能说明】

RTMP推流状态回调。

【回调参数】

• code：错误码，成功为0，失败请参见HWRtcErrorCode。
• taskId：任务Id。
• urlList：推流的url状态，具体请参见HRTCRtmpUrlInfoModel。

onTopActiveSpeaker

- (void)onTopActiveSpeaker:(NSString *_Nonnull)userId;

【功能说明】

声控画面的用户ID变化时，触发此回调。该回调主要用于0号会场场景。

onScreenShareStarted

- (void)onScreenShareStarted;

【功能说明】

当前状态是系统录屏开启成功回调。只有系统屏幕录制开启成功，才会开启辅流共享。

【回调参数】

无

只有iPhone才会生效。

onScreenShareStopped

- (void)onScreenShareStopped:(int)reason;

【功能说明】

当前状态是系统录屏完成回调。主动调用stopScreen，不会触发该回调。只有主动关闭系统的屏幕录制，才会回调。当前状态回调之后，不需要再调用stopScreen停止辅流。

【回调参数】

无

• 只有iPhone才会生效。
• reason参数目前只返回0。

onAudioDeviceTestVolumeNotify

- (void)onAudioDeviceTestVolumeNotify:(HWRtcAudioDeviceTestVolumeNotify * _Nonnull)result;

【功能说明】

音频设备测试回调。

【回调参数】

result：回调数据，具体请参见HWRtcAudioDeviceTestVolumeNotify。

onRemoteMicrophoneStateChanged

- (void)onRemoteMicrophoneStateChanged:(NSString * _Nonnull)userId state:(HWRtcRemoteMicState)state;

【功能说明】

远端用户麦克风状态变更通知。

【回调参数】

userId：远端用户userId。

state：麦克风设备状态，具体请参见HWRtcRemoteMicState。

onUserNetworkQualityNotify

- (void)onUserNetworkQualityNotify:(NSString *_Nullable)roomId userId:(NSString *_Nullable)userId 
       txQuality:(HWRtcNetworkQualityLevel)txQuality rxQuality:(HWRtcNetworkQualityLevel)rxQuality;

【功能说明】

支持用户上报各自与近端SFU间的上下行网络质量，基于用户级，使本地用户能获取同房间内远端用户与其近端SFU间的网络质量。CMD广播时为房间级，将广播给订阅了此主播流的用户或者此主播被选为TOPN用户且观众订阅了该TOPN用户。

【回调参数】

• roomId：用户所在房间号。
• userId: 上报的用户id，0为本地，非0为远端。
• txQuality：该用户的上行网络质量，具体请参见HWRtcNetworkQualityLevel。
• rxQuality：该用户的下行网络质量，具体请参见HWRtcNetworkQualityLevel。

onMultiRoomMediaRelayStateChanged

- (void)onMultiRoomMediaRelayStateChangedWithRoomId:(NSString *)roomId state:(HWRtcMultiRoomMediaRelayState)state code:(HWRtcMultiRoomMediaRelayStateCode)code

【功能说明】

跨房状态回调。

【回调参数】

roomId：跨房房间号。

state：状态类型，具体请参见HRTCMultiRoomMediaRelayState。

code：状态的具体原因，具体请参见HRTCMultiRoomMediaRelayStateCode。

onMediaAddressNotify

- (void)onMediaAddressNotify:(NSString * _Nonnull)mediaIpv4 mediaIpv6:

【功能说明】

加入房间成功之后，回调SFU的ipv4和ipv6地址。

【回调参数】

mediaIpv4：sfu ipv4地址。

mediaIpv6：sfu ipv6地址。