文档首页 > > SDK参考> iOS SDK> 接口参考> 事件回调

事件回调

分享
更新时间:2020/11/02 GMT+08:00

本章节介绍了iOS SDK的回调接口HWRtcEngineDelegate的详情。

表1 回调

接口

描述

onJoinSuccess

成功加入房间回调

onJoinRoomFailure

加入房间失败回调

onRejoinRoomSuccess

重新加入房间成功回调

onLeaveRoom

离开房间回调

onUserJoined

用户加入房间回调

onUserOffline

用户离开房间回调

onFirstRemoteVideoDecoded

远端用户第一帧解码成功回调

onStreamAvailable

获取默认流的回调

onUserRoleChange

用户角色切换成功回调

onConnStateChange

连接状态改变回调

onError

错误回调

onWarning

警告回调,暂时不用

onSignatureExpired

签名过期回调

onDeviceStateChanged

设备状态改变回调(仅macOS)

onAudioVolumeChanged

音频音量改变回调(仅macOS)

onAudioRouteChange

音频路由改变回调(仅iOS)

onLogUploadResult

日志上传结果回调

onLogUploadProgress

日志上传进度回调

onRemoteAudioStateChange

音频流状态改变回调

onRemoteVideoStateChange

视频流状态发生改变回调

onUserVolumeStats

最大发言人音量回调

onStartAudioFile

播放音频文件状态回调

onStopAudioFile

停止播放音频文件回调

onPauseAudioFile

暂停播放音频文件回调

onResumeAudioFile

恢复播放音频文件回调

onRenderVideoFrame

渲染视频帧回调

onPlaybackAudioFrame

渲染音频帧回调

onNetworkTestResult

入会前网络检测回调状态

onNetworkTestQuality

入会前网络检测质量状态

onJoinSuccess

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

功能说明

加入房间成功回调。

回调参数
  • roomId :房间ID
  • userId:用户ID。

onJoinRoomFailure

- (void)onJoinRoomFailure;

功能说明

加入房间失败回调。

回调参数

无。

onRejoinRoomSuccess

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

功能说明

重新加入房间成功。

回调参数
  • roomid:房间ID。
  • userid: 用户ID。

onLeaveRoom

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

功能说明

离开房间回调。

回调参数

onUserJoined

-(void)onUserJoined:(NSString*)roomId userId:(NSString*)userId nickName:(NSString*)nickName;

功能说明

用户加入成功回调。

回调参数

  • roomId :房间ID。
  • userId:用户ID。
  • nickName:用户昵称。

onUserOffline

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

功能说明

用户离开回调。

回调参数
  • roomId :房间ID。
  • userId:用户ID。
  • reason:预留。

onFirstRemoteVideoDecoded

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

功能说明

远端首帧解码成功回调。

回调参数
  • userId :用户ID。
  • width :视频宽度。
  • height :视频高度。

onStreamAvailable

- (void)onStreamAvailable:(NSString *)roomid userid:(NSString *)userid streamType:(HWRtcStreamType)streamType;

功能说明

获取默认流的回调。

回调参数
  • roomid : 默认流房间。
  • userid :用户ID。
  • streamType:流支持选看的类型,具体请参见HWRtcStreamType

onUserRoleChange

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

功能说明

用户角色切换成功回调。

回调参数
  • newRole :新角色,具体请参见HWRtcRole
  • oldRole :旧角色,具体请参见HWRtcRole

onConnStateChange

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

功能说明

连接状态改变回调。

回调参数

onError

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

功能说明

错误回调。

回调参数
  • errorCode :错误码
  • errorMsg :错误信息

onWarning

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

功能说明

警告回调,暂时不用。

回调参数
  • warningCode:警告码
  • warningMsg:警告信息

onSignatureExpired

- (void)onSignatureExpired;

功能说明

签名过期回调。

回调参数

onDeviceStateChanged

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

功能说明

设备状态改变回调。

回调参数

【注意事项】

支持macOS。

onAudioVolumeChanged

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

功能说明

音频音量改变回调。

回调参数
  • deviceType :设备类型,具体请参见HWRtcDeviceType
  • volume:音量

【注意事项】

支持macOS。

onAudioRouteChange

- (void)onAudioRouteChange:(HWRtcAudioRoute)audioRoute;

功能说明

音频路由发生改变回调。

回调参数

audioRoute:音频路由类型,具体请参见HWRtcAudioRoute

注意事项

支持IPHONE。

onLogUploadResult

-(void)onLogUploadResult:(int)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;

功能说明

远端音频流状态发生改变回调。

回调参数
  • roomid:房间ID。
  • userid:用户ID。

onRemoteVideoStateChange

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

功能说明

远端视频流状态发生改变回调。

回调参数

onUserVolumeStats

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

功能说明

最大发言人音量回调。

回调参数
  • usersVolumeArray:回调发言人音量信息,具体请参见HWRtcMediaUsersVolumeInfo
  • userNumber:发言人总数量,最大支持4个。
  • totalVolume:总音量。

onStartAudioFile

- (void)onStartAudioFile:(BOOL)isSuccess

功能说明

播放音频文件状态。

回调参数

isSuccess:YES表示成功,NO表示失败。

onStopAudioFile

- (void)onStopAudioFile:(BOOL)isSuccess

功能说明

停止播放音频文件回调。

回调参数

isSuccess:YES表示成功,NO表示失败。

onPauseAudioFile

- (void)onPauseAudioFile:(BOOL)isSuccess

功能说明

暂停播放音频文件回调。

回调参数

isSuccess:YES表示成功,NO表示失败。

onResumeAudioFile

- (void)onResumeAudioFile:(BOOL)isSuccess

功能说明

恢复播放音频文件回调。

回调参数

isSuccess:YES表示成功,NO表示失败。

onRenderVideoFrame

- (void)onRenderVideoFrame:(NSString *_Nonnull)roomid meidaDirection:(HWRTCMediaDirection)meidaDirection videoFrame:(HWRtcVideoFrame * _Nonnull)videoFrame;

功能说明

渲染视频帧回调。

回调参数

onPlaybackAudioFrame

- (void)onPlaybackAudioFrame:(NSString *_Nonnull)roomid meidaDirection:(HWRTCMediaDirection)meidaDirection audioFrame:(HWRtcAudioFrame * _Nonnull)audioFrame;

功能说明

渲染音频帧回调。

回调参数
  • roomid :房间ID。
  • audioFrame 音频帧,具体请参见HWRtcAudioFrame

onNetworkTestResult

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

功能说明

入会前网络检测回调状态。

回调参数

onNetworkTestQuality

-(void)onNetworkTestQuality:(int)level;

功能说明

入会前网络检测回调状态。

回调参数
  • level:检测网络质量 1-4级,4级网络质量最好。
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问