华为云用户手册

  • onAuxiliaryStreamStatsNotify virtual void onAuxiliaryStreamStatsNotify(HRTCLocalVideoStats *localStats, unsigned int localStatsCount, HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 辅流详情,2s触发一次回调。 【回调参数】 localStats:本地辅流发流统计,具体请参见HRTCLocalVideoStats。 localStatsCount:localStats数组长度。 remoteStats:远端辅流收流统计,具体请参见HRTCRemoteVideoStats。 remoteStatsCount:remoteStats数组长度。
  • onRemoteVideoStateChangedNotify virtual void onRemoteVideoStateChangedNotify(const char* userId, HRTCRemoteVideoStreamState state, HRTCRemoteVideoStreamStateReason reason) 【功能说明】 远端视频流状态变化回调。 【回调参数】 userId:远端用户ID。 state:远端视频流状态,具体请参见HRTCRemoteVideoStreamState。 reason:远端视频流状态变化原因,具体请参见HRTCRemoteVideoStreamStateReason。
  • onPlaybackExternalAudioFrame virtual void onPlaybackExternalAudioFrame(const char* roomId, HRTCMediaDirection direction, HRTCAudioFrame& audioFrame) 【功能说明】 音频自渲染回调。需要调用setExternalAudioFrameOutput接口开启音频自渲染,从而触发该回调。 【回调参数】 roomId:房间ID。 direction:数据源,本地数据,远端数据,具体请参见HRTCMediaDirection。 audioFrame:音频帧详情,具体请参见HRTCAudioFrame。
  • onLocalVideoStateChangedNotify virtual void onLocalVideoStateChangedNotify(HRTCLocalVideoStreamState state, HRTCLocalVideoStreamStateReason reason) 【功能说明】 本地视频状态改变,触发此回调。 【回调参数】 state:本地视频状态,具体请参见HRTCLocalVideoStreamState。 reason:本地视频状态改变原因,具体请参见HRTCLocalVideoStreamStateReason。
  • onNetworkQualityNotify virtual void onNetworkQualityNotify(HRTCQualityInfo* localQuality, unsigned int localQualityCount, HRTCQualityInfo* remoteQuality, unsigned int remoteQualityCount) 【功能说明】 房间内客户端基于流级别的网络质量实时上报,默认开启,每2s上报一次,有数据流时才会回调,音频流、视频流分开回调。 【回调参数】 localQuality:本地上行网络质量,该参数暂时不使用。 localQualityCount:正在上报的网络质量数量,该参数暂时不使用。 remoteQuality:(本地下行)远端各路流的网络质量,具体请参见HRTCQualityInfo。 remoteQualityCount:正在上报的流的数量,集合的大小。
  • onRemoteAudioStateChangedNotify virtual void onRemoteAudioStateChangedNotify(const char* userId, HRTCRemoteAudioStreamState state, HRTCRemoteAudioStreamStateReason reason) 【功能说明】 远端音频流状态变化回调。 【回调参数】 userId:远端用户ID。 state:远端音频流状态,具体请参见HRTCRemoteAudioStreamState。 reason:远端音频流状态变化原因,具体请参见HRTCRemoteAudioStreamStateReason。
  • onUserVolumeStatsNotify virtual void onUserVolumeStatsNotify(const HRTCVolumeInfo* userVolumes, unsigned int userVolumesCount, unsigned int totalVolume) 【功能说明】 用户音量状态回调。通过enableUserVolumeNotify开启并设置回调周期,定时上报。 【回调参数】 userVolumes:用户信息,具体请参见HRTCVolumeInfo。 userVolumesCount:上报的用户人数,包含本地用户。 totalVolume:总音量。
  • onLocalAudioStateChangedNotify virtual void onLocalAudioStateChangedNotify(HRTCLocalAudioStreamState state, HRTCLocalAudioStreamStateReason reason) 【功能说明】 本地音频状态改变,触发此回调。 【回调参数】 state:本地音频状态,具体请参见HRTCLocalAudioStreamState。 reason:本地音频状态改变的原因,具体请参见HRTCLocalAudioStreamStateReason。
  • onMediaConnectStateChangedNotify virtual void onMediaConnectStateChangedNotify(HRTCMediaConnStateTypes state, HRTCMediaConnChangeReason reason, const char* description) 【功能说明】 媒体服务器连接状态变更通知。 【回调参数】 state:与媒体服务器连接状态,具体请参见HRTCMediaConnStateTypes。 reason:连接状态变化的原因,具体请参见HRTCMediaConnChangeReason。 description:连接状态变化原因描述。 加入房间过后,收到媒体服务的数据包时,返回Connected消息,超过6s没有收到包,则返回Failed消息。
  • onRenderAuxiliaryExternalVideoFrame virtual void onRenderAuxiliaryExternalVideoFrame(const char* roomId, HRTCMediaDirection direction, const char* userId, HRTCVideoFrame& videoFrame) 【功能说明】 辅流自渲染回调。需要调用setAuxiliaryExternalVideoFrameOutput接口开启辅流自渲染,从而触发该回调。 【回调参数】 roomId:房间ID。 direction:数据源,本地数据,远端数据,具体请参见HRTCMediaDirection。 userId:用户ID。 videoFrame:辅流详情,具体请参见HRTCVideoFrame。
  • onRemoteUserOffline virtual void onRemoteUserOffline(const char* roomId, const char* userId, int reason) 【功能说明】 远端joiner用户离开当前房间,触发此回调。 本端用户离开当前房间,会回调当前房间所有用户offline。 【回调参数】 roomId:当前房间的房间ID。 userId:离开房间的远端用户ID。 reason:远端用户离线原因,预留参数。
  • onRemoteUserNameChangedNotify virtual void onRemoteUserNameChangedNotify(const char* roomId, const char* userId, const char* userName) 【功能说明】 远端用户昵称变化,触发此回调。 【回调参数】 roomId:房间ID。 userId:用户ID。 userName:变更后的昵称。
  • onFirstRemoteVideoDecoded virtual void onFirstRemoteVideoDecoded(const char* roomId, const char* userId, int width, int height) 【功能说明】 接收到第一帧远端视频流并解码成功,触发此回调。 【回调参数】 roomId:视频流对应的房间ID。 userId:视频流对应的用户ID。 width:视频流宽。 height:视频流高。
  • onConnectionChangedNotify virtual void onConnectionChangedNotify(HRTCConnStateTypes connType, HRTCConnChangeReason reason, const char* description) 【功能说明】 网络连接状态发生变化,触发此回调。 【回调参数】 connType:网络连接状态。具体请参见HRTCConnStateTypes。 reason:网络连接状态发生变化原因。具体请参见HRTCConnChangeReason。 description:错误原因描述。
  • onAudioStatsNotify virtual void onAudioStatsNotify(HRTCLocalAudioStats *localStats, unsigned int localStatsCount, HRTCRemoteAudioStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 音频流详情,2s触发一次回调。 【回调参数】 localStats:本地音频发流统计,具体请参见HRTCLocalAudioStats。 localStatsCount:localStats数组长度。 remoteStats:远端音频收流统计,具体请参见HRTCRemoteAudioStats。 remoteStatsCount:remoteStats数组长度。 当无本地音频时,localStatsCount为0,localStats为空指针,需要先判断不为空再使用,否则可能引发空指针错误。 当无远端音频时,remoteStatsCount为0,remoteStats为空指针,需要先判断不为空再使用,否则可能引发空指针错误。
  • onRemoteUserOnline virtual void onRemoteUserOnline(const char* roomId, const char* userId, const char* userName) 【功能说明】 远端joiner用户加入当前房间,触发此回调。该回调提示有远端joiner用户加入了房间,并返回新加入用户的ID。 【回调参数】 roomId:房间ID。 userId:远端用户ID。 userName:远端用户昵称。
  • onDeviceStateChangedNotify virtual void onDeviceStateChangedNotify(const char* deviceId, HRTCDeviceType deviceType, HRTCDeviceState deviceState) 【功能说明】 设备状态发生变化,触发此回调。 【回调参数】 deviceId:系统设备标识,如系统音频播放设备标识可通过getPlaybackDevices获取。 deviceType:系统设备类型,具体请参见HRTCDeviceType。 deviceState:系统设备状态,具体请参见HRTCDeviceState。 通话前插拔设备会上报变化。
  • onFirstRemoteAuxiliaryStreamDecoded virtual void onFirstRemoteAuxiliaryStreamDecoded(const char* roomId, const char* userId, int width, int height) 【功能说明】 接收到第一帧远端辅流并解码成功,触发此回调。 【回调参数】 roomId:视频流对应的房间ID。 userId:视频流对应的用户ID。 width:视频流宽。 height:视频流高。
  • onDeviceVolumeChangedNotify virtual void onDeviceVolumeChangedNotify(HRTCDeviceType deviceType, unsigned int volume, unsigned int muted) 【功能说明】 音频设备音量发生变化,触发此回调。 【回调参数】 deviceType:系统设备类型,具体请参见HRTCDeviceType。 volume:音量 muted:true表示设备静音,false表示设备未静音。 通话前调整音频设备音量和静音会上报变化。
  • onLeaveRoom virtual void onLeaveRoom(HRTCLeaveReason reason, const HR TCS tatsInfo &statsInfo) 【功能说明】 离开房间,触发此回调。 【回调参数】 reason:离开的房间原因,具体请参见HRTCLeaveReason。 statsInfo:卡顿统计信息,具体请参见HRT CS tatsInfo。 APP调用leaveRoom接口时,会返回HRTC_LEAVE_REASON_USER_LEAVE_ROOM,可以通过以下任一方式回退到登录界面。 APP在调用leaveRoom接口时退到登录界面,或者在收到onLeaveRoom回调,且回调消息不等于HRTC_LEAVE_REASON_USER_LEAVE_ROOM时(防止重复操作)退到登录界面。 APP只在收到onLeaveRoom消息时退到登录界面。
  • onUserRoleChangedNotify virtual void onUserRoleChangedNotify(const char* roomId, HRTCRoleType oldRole, HRTCRoleType newRole) 【功能说明】 用户角色切换成功,触发此回调。 【回调参数】 roomId:发生角色切换的房间号。 oldRole:切换前的角色。具体请参见HRTCRoleType。 newRole:切换成功后的角色。具体请参见HRTCRoleType。
  • onUserAuxiliaryStreamAvailable virtual void onUserAuxiliaryStreamAvailable(const char* roomId, const char* userId, bool available) 【功能说明】 远端开启,停止辅流后,触发此回调。 【回调参数】 roomId:房间ID。 userId:远端用户ID。 available:true表示远端开启辅流,false表示远端停止辅流。
  • onVideoStatsNotify virtual void onVideoStatsNotify(HRTCLocalVideoStats *localStats, unsigned int localStatsCount, HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 视频流详情,2s触发一次回调。 【回调参数】 localStats:本地视频发流统计,具体请参见HRTCLocalVideoStats。 localStatsCount:localStats数组长度。 remoteStats:远端视频收流统计,具体请参见HRTCRemoteVideoStats。 remoteStatsCount:remoteStats数组长度。 当无本地视频时,localStatsCount为0,localStats为空指针,需要先判断不为空再使用,否则可能引发空指针错误。 当无远端视频时,remoteStatsCount为0,remoteStats为空指针,需要先判断不为空再使用,否则可能引发空指针错误。
  • 服务端错误码 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要APP干预或进行用户提示。该错误码由服务端产生,通过onError返回。 表1 服务端错误码 错误码 描述 错误原因 RTC.10000001 内部错误 程序或环境问题 RTC.31000000 节点不存在 程序或环境问题 RTC.31000001 session校验失败 程序或环境问题 RTC.31000003 内部异常 程序或环境问题 RTC.31000004 认证失败 用户使用问题 RTC.31000005 请重试 用户使用问题 RTC.31000006 需要时钟同步 用户使用问题 RTC.31000007 请求资源不存在 程序或环境问题 RTC.32000000 服务异常 程序或环境问题 RTC.32000001 流号已满 程序或环境问题 RTC.32000002 SFU为空 程序或环境问题 RTC.32000004 下发流信息失败 程序或环境问题 RTC.32000005 添加适配器失败 程序或环境问题 RTC.32000006 添加路由失败 程序或环境问题 RTC.32000007 获取用户信息异常 程序或环境问题 RTC.32000010 选看用户不存在 程序或环境问题 RTC.32000011 音频速率参数非法 程序或环境问题 RTC.32000012 用户列表为空 程序或环境问题 RTC.32000013 非法请求参数 程序或环境问题 RTC.32000015 内部调用异常 程序或环境问题 RTC.32000016 内部调用异常 程序或环境问题 RTC.32000017 站点不存在 程序或环境问题 RTC.32000018 错误的加密算法 程序或环境问题 RTC.32000019 客户端媒体加密密钥base64解码失败 程序或环境问题 RTC.32000020 生成媒体加密密钥失败 程序或环境问题 RTC.32000021 下发加密信息异常 程序或环境问题 RTC.32000022 获取SFU的IP失败 程序或环境问题 RTC.32000024 内部调用异常 程序或环境问题 RTC.32000025 内部调用异常 程序或环境问题 RTC.32000028 不支持的操作 程序或环境问题 RTC.32000030 sfu资源不足 程序或环境问题 RTC.32000032 跨房数量超过上限 用户使用问题 RTC.32000033 不允许重复跨入同一房间 用户使用问题 RTC.32000034 稍后重试 程序或环境问题 RTC.33000000 服务异常 程序或环境问题 RTC.33000001 节点不存在 程序或环境问题 RTC.34000001 房间已满 用户使用问题 RTC.34000002 房间不存在 程序或环境问题 RTC.34000003 站点不存在 程序或环境问题 RTC.34000004 内部调用异常 程序或环境问题 RTC.34000006 用户不存在 用户使用问题 RTC.34000007 已存在辅流共享 用户使用问题 RTC.200001 请求参数不正确 用户使用问题 RTC.200030 没有可用的mcu资源 云测问题 RTC.200031 创建推流任务失败 云测问题 RTC.200032 混流任务已存在 用户使用问题 RTC.200033 混流任务不存在 用户使用问题 RTC.200034 参与混流的用户为空 用户使用问题 父主题: 接口参考
  • onUserAuxiliaryStreamAvailable - (void)onUserAuxiliaryStreamAvailable:(NSString * _Nonnull)roomId userId:(NSString * _Nonnull)userId isAvailable:(BOOL)isAvailable; 【功能说明】 辅流状态回调。 【回调参数】 roomId:房间ID。 userId:远端用户ID。 isAvailable:YES表示辅流推送中,NO表示辅流停止推送。
  • onLocalAudioStateChangedNotify -(void)onLocalAudioStateChangedNotify:(HWRtcLocalAudioState)state reason:(HWRtcLocalAudioStateReason)reason; 【功能说明】 本地音频流状态变化回调。 【回调参数】 state:本地音频流状态。具体请参见 HWRtcLocalAudioState。 reason:本地音频流状态变化原因。具体请参见 HWRtcLocalAudioStateReason。
  • onRemoteVideoResolutionChangedNotify - (void)onRemoteVideoResolutionChangedNotify:(NSString *_Nullable)userId width:(NSInteger)width height:(NSInteger)height; 【功能说明】 远端视频大小改变回调。 【回调参数】 userId:用户ID。 width:视频流宽度。 height:视频流高度。
  • onAudioDeviceTestVolumeNotify - (void)onAudioDeviceTestVolumeNotify:(HWRtcAudioDeviceTestVolumeNotify * _Nonnull)result; 【功能说明】 本地音频采集音量回调。 【回调参数】 result:本地音频采集音量结果, 具体请参见HWRtcAudioDeviceTestVolumeNotify。
  • onPlaybackExternalAudioFrame - (void)onPlaybackExternalAudioFrame:(NSString *_Nonnull)roomid meidaDirection:(HWRtcMediaDirection)meidaDirection audioFrame:(HWRtcAudioFrame * _Nonnull)audioFrame; 【功能说明】 音频自渲染回调。需要调用setExternalMediaFrameOutput接口开启音频自渲染,从而触发该回调。 【回调参数】 roomid :房间ID。 meidaDirection:数据源(本地/远端数据),具体请参见HWRTCMediaDirection。 audioFrame:音频帧详情,具体请参见HWRtcAudioFrame。
  • onAudioMixStateChangedNotify - (void)onAudioMixStateChangedNotify:(HWRtcAudioFileState)state reason:(HWRtcAudioFileReason)reason value:(NSUInteger)value; 【功能说明】 混音音频文件播放状态改变回调。 回调参数 state:音频文件播放状态,具体请参见 HWRtcAudioFileState reason:音频文件播放状态变化原因,具体请参见 HWRtcAudioFileReason value:state为HWRtcAudioFileOpenCompleted表示音频文件的时长,单位ms;state为HWRtcAudioFilePositionUpdate表示当前播放的位置,单位ms。其他情况下,value值无意义。
共100000条