华为云用户手册

onRemoteAudioStateChangedNotify virtual void onRemoteAudioStateChangedNotify(IHRTCConnection* conn, const char* userId, HRTCRemoteAudioStreamState state, HRTCRemoteAudioStreamStateReason reason) 【功能说明】 远端音频流状态变化回调。 【回调参数】 conn：连接对象。 userId：远端用户ID。 state：远端音频流状态，具体请参见HRTCRemoteAudioStreamState。 reason：远端音频流状态变化原因，具体请参见HRTCRemoteAudioStreamStateReason。

onAudioStatsNotify virtual void onAudioStatsNotify(IHRTCConnection* conn, HRTCLocalAudioStats *localStats, unsigned int localStatsCount, HRTCRemoteAudioStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 音频流详情，2s触发一次回调。 【回调参数】 conn：连接对象。 localStats：本地音频发流统计，具体请参见HRTCLocalAudioStats。 localStatsCount：localStats数组长度。 remoteStats：远端音频收流详情，具体请参见HRTCRemoteAudioStats。 remoteStatsCount：remoteStats数组长度。 当无本地音频时，localStatsCount为0，localStats为空指针。 当无远端音频时，remoteStatsCount为0，remoteStats为空指针。

onVideoStatsNotify virtual void onVideoStatsNotify(IHRTCConnection* conn, HRTCLocalVideoStats *localStats, unsigned int localStatsCount, HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 视频流详情，2s触发一次回调。 【回调参数】 conn：连接对象。 localStats：本地视频发流统计，具体请参见HRTCLocalVideoStats。 localStatsCount：localStats数组长度。 remoteStats：远端视频收流统计，具体请参见HRTCRemoteVideoStats。 remoteStatsCount：remoteStats数组长度。 当无本地视频时，localStatsCount为0，localStats为空指针。 当无远端视频时，remoteStatsCount为0，remoteStats为空指针。

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消息时退到登录界面。

onRemoteUserOnline virtual void onRemoteUserOnline(const char* roomId, const char* userId, const char* userName) 【功能说明】 远端joiner用户加入当前房间，触发此回调。该回调提示有远端joiner用户加入了房间，并返回新加入用户的ID。 【回调参数】 roomId：房间ID。 userId：远端用户ID。 userName：远端用户昵称。

onUserRoleChangedNotify virtual void onUserRoleChangedNotify(IHRTCConnection* conn, HRTCRoleType oldRole, HRTCRoleType newRole) 【功能说明】 用户角色切换成功，触发此回调。 【回调参数】 conn：连接对象。 oldRole：切换前的角色。具体请参见HRTCRoleType。 newRole：切换成功后的角色。具体请参见HRTCRoleType。

onRemoteUserOnline virtual void onRemoteUserOnline(IHRTCConnection* conn, const char* userId, const char* userName) 【功能说明】 远端joiner用户加入当前房间，触发此回调。该回调提示有远端joiner用户加入了房间，并返回新加入用户的ID。 【回调参数】 conn：连接对象。 userId：远端用户ID。 userName：远端用户昵称。

onRemoteUserNameChangedNotify virtual void onRemoteUserNameChangedNotify(IHRTCConnection* conn, const char* userId, const char* userName) 【功能说明】 远端用户昵称变化，触发此回调。 【回调参数】 conn：连接对象。 userId：用户ID。 userName：变更后的昵称。

onUserVolumeStatsNotify virtual void onUserVolumeStatsNotify(IHRTCConnection* conn, const HRTCVolumeInfo* userVolumes, unsigned int userVolumesCount, unsigned int totalVolume) 【功能说明】 用户音量状态回调。通过enableUserVolumeNotify开启并设置回调周期，定时上报。 【回调参数】 conn：连接对象。 userVolumes：HRTCVolumeInfo，userId，volume。 userVolumesCount：音量上报用户数组的大小。 totalVolume：总音量。

onUserAuxiliaryStreamAvailable virtual void onUserAuxiliaryStreamAvailable(IHRTCConnection* conn, const char* userId, bool available) 【功能说明】 远端开启，停止辅流后，触发此回调。 【回调参数】 conn：连接对象。 userId：远端用户ID。 available：true表示远端开启推辅流，false表示远端停止辅流。

onFirstRemoteAuxiliaryStreamDecoded virtual void onFirstRemoteAuxiliaryStreamDecoded(IHRTCConnection* conn, const char* userId, int width, int height) 【功能说明】 远端用户辅流第一帧解码成功，触发此回调。 【回调参数】 conn：连接对象。 userId：用户ID。 width：视频宽。 height：视频高。

onAuxiliaryStreamStatsNotify virtual void onAuxiliaryStreamStatsNotify(IHRTCConnection* conn, HRTCLocalVideoStats *localStats, unsigned int localStatsCount, HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 辅流详情，2s触发一次回调。 【回调参数】 conn：连接对象。 localStats：本地辅流发流详情，具体请参见HRTCLocalVideoStats。 localStatsCount：本地辅流发流数量。 remoteStats：远端辅流收流详情，具体请参见HRTCRemoteVideoStats。 remoteStatsCount：远端辅流收流数量。

onLeaveRoom virtual void onLeaveRoom(IHRTCConnection* conn, HRTCLeaveReason reason, const HRTCStatsInfo &statsInfo) 【功能说明】 离开房间，触发此回调。 【回调参数】 conn：连接对象。 reason：离开的房间原因，具体请参见HRTCLeaveReason。 statsInfo：卡顿统计信息，具体请参见HRTCStatsInfo。

onRemoteUserOffline virtual void onRemoteUserOffline(IHRTCConnection* conn, const char* userId, int reason) 【功能说明】 远端joiner用户离开当前房间，触发此回调。 本端用户离开当前房间，会回调当前房间所有用户offline。 【回调参数】 conn：连接对象。 userId：离开房间的远端用户ID。 reason：远端用户离线原因，预留参数。

onRemoteUserOffline virtual void onRemoteUserOffline(const char* roomId, const char* userId, int reason) 【功能说明】 远端joiner用户离开当前房间，触发此回调。 本端用户离开当前房间，会回调当前房间所有用户offline。 【回调参数】 roomId：当前房间的房间ID。 userId：离开房间的远端用户ID。 reason：远端用户离线原因，预留参数。

onConnectionChangedNotify void onConnectionChangedNotify(HRTCConnStateTypes connStateTypes, HRTCConnChangeReason connChangeReason, String description); 【功能说明】 网络连接状态改变。 【回调参数】 connStateTypes：网络连接状态，具体请参见HRTCConnStateTypes。 connChangeReason：网络连接状态原因，具体请参见HRTCConnChangeReason。 description：描述。

onUserAuxiliaryStreamAvailable void onUserAuxiliaryStreamAvailable(String roomId, String userId, boolean available); 【功能说明】 辅流加入房间。 【回调参数】 roomId：房间ID。 userId：用户ID。 available：true表示辅流开始推送，false表示辅流停止推送，提示用户关闭共享。

onPlaybackExternalAudioFrame void onPlaybackExternalAudioFrame(String roomId,HRTCMediaDirection direction, HRTCAudioFrame audioFrame); 【功能说明】 回调远端的音频原始数据流。 【回调参数】 roomId：房间ID。 audioFrame：音频数据，具体请参见HRTCAudioFrame。 direction：数据源，本地数据，远端数据，具体请参见HRTCMediaDirection。

onMediaConnectStateChangedNotify void onMediaConnectStateChangedNotify(HRTCMediaConnStateTypes state, HRTCMediaConnChangeReason reason, String description); 【功能说明】 媒体服务器连接状态变更通知。 【回调参数】 state：连接状态，具体请参见HRTCMediaConnStateTypes。 reason：连接状态变化的原因，具体请参见HRTCMediaConnChangeReason。 description：连接状态变化原因描述。 加入房间过后，收到媒体服务的数据包时，返回Connected消息，超过6s没有收到包，则返回Failed消息。

onRenderExternalVideoFrame void onRenderExternalVideoFrame(String roomId, HRTCMediaDirection direction, String userId, HRTCVideoFrame videoFrame); 【功能说明】 回调远端的视频原始数据流。 【回调参数】 roomId：房间ID。 userId：用户ID。 videoFrame：视频数据。 direction：数据源，本地数据，远端数据，具体请参见HRTCMediaDirection。

onRemoteAudioStateChangedNotify void onRemoteAudioStateChangedNotify(String userId, HRTCRemoteAudioStreamState state, HRTCRemoteAudioStreamStateReason reason); 【功能说明】 远端音频流状态变化回调。 【回调参数】 userId：远端用户ID。 state：远端音频流状态，具体请参见HRTCRemoteAudioStreamState。 reason：远端音频流状态变化原因，具体请参见HRTCRemoteAudioStreamStateReason。

onFirstRemoteAuxiliaryStreamDecoded void onFirstRemoteAuxiliaryStreamDecoded(String roomId, String userId, int width, int height); 【功能说明】 接收到第一帧远端辅流并解码成功，触发此回调。 【回调参数】 roomId：视频流对应的房间ID。 userId：视频流对应的用户ID。 width：视频流宽。 height：视频流高。

onLocalVideoStateChangedNotify void onLocalVideoStateChangedNotify(HRTCLocalVideoStreamState state, HRTCLocalVideoStreamStateReason reason); 【功能说明】 本地视频流状态变化回调。 【回调参数】 state：本地视频流状态，具体请参见HRTCLocalVideoStreamState。 reason：本地视频流状态变化原因，具体请参见HRTCLocalVideoStreamStateReason

onAudioMixStateChangedNotify void onAudioMixStateChangedNotify(HRTCAudioFileState state, HRTCAudioFileReason reason, long value); 【功能说明】 音频文件播放状态改变回调。 【回调参数】 state：音频文件播放状态，具体请参见HRTCAudioFileState。 reason：音频文件播放状态变化原因，具体请参见HRTCAudioFileReason。 value：state为HRTC_AUDIO_FILE_OPEN_COMPLETED表示音频文件的时长，单位为ms；state为HRTC_AUDIO_FILE_POSITION_UPDATE表示当前播放的位置，单位为ms。其他情况下，value值无意义。

onUserRoleChangedNotify void onUserRoleChangedNotify(String roomId, HRTCRoleType oldRole, HRTCRoleType newRole); 【功能说明】 用户角色改变。 【回调参数】 roomId：发生角色切换的房间号。 oldRole：改变前的角色，具体请参见HRTCRoleType。 newRole：改变后的角色，具体请参见HRTCRoleType。

onLocalAudioStateChangedNotify void onLocalAudioStateChangedNotify(HRTCLocalAudioStreamState state, HRTCLocalAudioStreamStateReason reason); 【功能说明】 本地音频流状态变化回调。 【回调参数】 state：本地音频流状态，具体请参见HRTCLocalAudioStreamState。 reason：本地音频流状态变化原因，具体请参见HRTCLocalAudioStreamStateReason。

onConnectionChangedNotify virtual void onConnectionChangedNotify(IHRTCConnection* conn, HRTCConnStateType state, HRTCConnChangeReason reason, const char* description) 【功能说明】 连接状态改变回调。 【回调参数】 conn：连接对象。 state：连接状态类型，具体请参见HRTCConnStateTypes。 reason：连接状态改变原因，具体请参见HRTCConnChangeReason。 description：连接状态改变描述。

onRemoteVideoStateChangedNotify void onRemoteVideoStateChangedNotify(String userId, HRTCRemoteVideoStreamState state, HRTCRemoteVideoStreamStateReason reason); 【功能说明】 远端视频流状态变化回调。 【回调参数】 userId：远端用户ID。 state：远端视频流状态，具体请参见HRTCRemoteVideoStreamState。 reason：远端视频流状态变化原因，具体请参见HRTCRemoteVideoStreamStateReason。

客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时，SDK无法自动恢复，需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUC CES S 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK内部系统错误 SDK内部异常。 HRTC_ERR_CODE_MSG_TOOLARGE 90000002 发送的消息太大 发送消息时，消息体太大。 HRTC_ERR_CODE_MEM_NOT_ENOUGH 90000003 内存不足 内存申请不到。 HRTC_ERR_CODE_SYNSEND_MSG_ERR 90000004 消息发送失败 消息队列异常，导致内部消息发送失败。 HRTC_ERR_CODE_PA RAM _ERROR 90000005 参数错误 包括如下两方面： 接口入参无效。 内部参数错误。 HRTC_ERR_CODE_API_CALLED_IN_WRONG_ORDER 90000006 API接口调用顺序不当 当前只有日志设置必须在初始化之前。 HRTC_ERR_CODE_SETUP_LOCAL_VIEW_FAIL 90000007 设置本地窗口失败 该错误码仅Android平台返回。 HRTC_ERR_CODE_START_REMOTE_STREAM_VIEW_FAIL 90000008 设置远端窗口失败 publisher场景没有远端画面，不应该设置；用户不存在；处于离会中等。 HRTC_ERR_CODE_SET_DEVICE_FAIL 90000009 设置设备失败 设置播放、录音、视频设备失败。 HRTC_ERR_CODE_INITIALIZING 90000010 初始化过程中 初始化过程中，不能再做初始化或者去初始化操作。 HRTC_ERR_CODE_UN_INITIALIZING 90000011 去初始化过程中 去初始化过程中，不能再做初始化或者去初始化操作。 HRTC_ERR_CODE_ LOG _UPLOADING 90000012 日志正在上传 日志正在上传过程中。 HRTC_ERR_CODE_MEDIA_PORT_ERROR 90000013 媒体端口获取失败 音频从10010开始，视频从10020开始，尝试10次，端口都被占用了。 HRTC_ERR_CODE_WATCH_VIEW_TOO_MUCH 90000014 视频选看超过规格 当前支持最多设置16个设置远端窗口，若超过，则会失败。 HRTC_ERR_CODE_MEDIA_CMP_ERR 90000015 媒体协商失败 与服务器之间媒体协商失败。 HRTC_ERR_CODE_SERVER_NO_RESPONSE 90000016 服务器没有响应 选看在2-4s内没有收到服务器的响应。 HRTC_ERR_CODE_USER_ROLE_CHANGE_FAIL 90000017 角色切换失败 角色切换失败。 HRTC_ERR_CODE_JOIN_ROOM_FAIL 90000018 加入房间失败 加入房间失败。 HRTC_ERR_CODE_JOIN_ROOM_STATUS_BUSY 90000019 加入房间失败 已在房间中或正在网络探测中。 HRTC_ERR_CODE_JOIN_ROOM_SERVER_ERROR 90000020 加入房间失败 加入房间失败，服务器异常。 HRTC_ERR_CODE_JOIN_ROOM_SERVICE_UNREACHABLE 90000021 加入房间失败 加入房间失败，服务不可达。 HRTC_ERR_CODE_JOIN_ROOM_AUTH_FAIL 90000022 加入房间失败 加入房间失败，鉴权失败。 HRTC_ERR_CODE_JOIN_ROOM_AUTH_RETRY 90000023 加入房间失败 加入房间失败，鉴权重试。 HRTC_ERR_CODE_JOIN_ROOM_CLOCK_SYNC 90000024 加入房间失败 加入房间失败，时钟同步。 HRTC_ERR_CODE_JOIN_ROOM_URL_NOT_RIGHT 90000025 加入房间失败 加入房间失败，url错误。 HRTC_ERR_CODE_KICKED_OFF 90000026 被踢出房间 相同用户ID等原因，被踢出房间。 HRTC_ERR_CODE_SCREEN_CAPTURE_FAIL 90000027 共享失败 房间内已经存在辅流等原因，导致共享失败。 HRTC_ERR_CODE_EXT_MEDIA_OUTPUT 90000028 设置输出设备错误 当开启媒体数据输出时，不允许设置输出设备，否则会报此异常。 HRTC_ERR_CODE_RECONNECT_FAILED 90000029 连接异常 重连失败。 HRTC_ERR_CODE_SERVER_BREAK_DOWN 90000030 服务器异常 服务器宕机。 HRTC_ERR_CODE_SIGNATURE_EXPIRED 90000031 签名过期 签名已过期。 HRTC_ERR_CODE_SET_REMOTE_RENDER_MODE_FAIL 90000032 设置视图模式失败 设置远端窗口模式失败。 HRTC_ERR_CODE_SET_REMOTE_AUDIO_MUTE_FAIL 90000033 设置远端音频接收失败 订阅或取消订阅音频失败。 HRTC_ERR_CODE_SET_USEROLE_NOT_ALLOWED 90000036 跨房后，不允许在本房间内做角色切换 跨房后，不允许在本房间内做角色切换，通过onError返回。 HRTC_ERR_CODE_EXT_MEDIA_CAPTURE_INPUT 90000037 当前为第三方采集模式，禁用该操作 开启第三方采集模式后，禁用部分操作。 HRTC_ERR_CODE_SET_EXTAUDIO_CAPTURE_FAIL 90000038 设置第三方音频采集失败 设置第三方音频采集失败。 HRTC_ERR_CODE_SET_EXTVIDEO_CAPTURE_FAIL 90000039 设置第三方视频采集失败 设置第三方视频采集失败。 HRTC_ERR_CODE_SET_SHARE_COMPUTER_SOUND_FAIL 90000040 设置共享声音开关失败 设置共享声音开关失败。 HRTC_ERR_CODE_SET_LOCAL_AUDIO_MUTE_FAIL 90000041 启停上行音频流失败 启停上行音频流失败。 HRTC_ERR_CODE_SET_LOCAL_VIDEO_MUTE_FAIL 90000042 启停上行视频流失败 启停上行视频流失败。 HRTC_ERR_CODE_USER_REMOVED 90000043 用户被移除 用户被移除。 HRTC_ERR_CODE_ROOM_DISMISSED 90000044 房间被解散 房间被解散。 HRTC_ERR_CODE_SETUP_REMOTE_VIEW_FAIL 90000045 设置远端View失败 设置远端View失败。 HRTC_ERR_CODE_REGION_NOT_COVERED 90000048 区域未覆盖 所在区域不能提供SparkRTC服务。 HRTC_ERR_CODE_SET_EXTDATA_CAPTURE_FAIL 90000049 设置第三方辅流采集失败 设置第三方辅流采集失败 HRTC_ERR_CODE_NOT_SUPPORT 90000050 该平台不支持此功能 该平台不支持此功能 HRTC_ERR_CODE_AUDIO_ROUTE_HANDLER_NOT_INIT 90000051 音频路由没有初始化 音频路由没有初始化 HRTC_ERR_CODE_AUDIO_ROUTE_PLUGIN_CONNECTED 90000052 音频路由外设连接 音频路由外设连接 HRTC_ERR_CODE_AUDIO_ROUTE_NO_NEED_CHANGE 90000053 音频设置路由和当前路由相同 音频设置路由和当前路由相同 HRTC_ERR_CODE_AUDIO_ROUTE_CHANGE_ERROR 90000054 音频路由切换失败 音频路由切换失败 HRTC_ERR_CODE_AUDIO_ROUTE_CLOSED 90000055 音频路由控制开关关闭，无法切换路由 音频路由控制开关关闭，无法切换路由 HRTC_ERR_CODE_LOCAL_AUDIO_DISABLE_FAIL 90000056 当前未推音频流 当前未推音频流 HRTC_ERR_CODE_ROLE_NOT_SUPPORT 90000057 当前角色不支持该操作 当前角色不支持该操作 HRTC_ERR_CODE_ENABLE_BACKGROUND_FAIL 90000058 没有动态加载ML图像分割库，不能支持背景虚化和背景替换能力 没有动态加载ML图像分割库，不能支持背景虚化和背景替换能力 HRTC_ERR_CODE_ENABLE_BACKGROUND_FAIL 90000059 背景虚化或背景替换开启失败 背景虚化或背景替换开启失败 HRTC_ERR_CODE_COMMAND_REMOTEUSER_FAIL 90000060 发送CMD时，目标用户不存在 发送CMD时，目标用户不存在 HRTC_ERR_CODE_COMMAND_NOTENABLED 90000061 CMD没有被启用 CMD没有被启用 HRTC_ERR_CODE_MSG_TOOQUICK 90000062 发送的消息太频繁 发送的消息太频繁 HRTC_ERR_CODE_MSG_API_CALL_UNREASONABLE 90000063 API调用不合理 API调用不合理 HRTC_ERR_CODE_VIDEO_BAD_STATE 90000064 模块状态错误 模块状态错误 HRTC_ERR_CODE_AUDIO_SHARE_FAIL 90000065 声音共享失败 声音共享失败 父主题： 接口参考

onAudioFrameRecord - (BOOL)onAudioFrameRecord:(HWRtcAudioFrame * _Nonnull)audioFrame; 【功能说明】 音频采集原始数据回调，对音频数据的修改会发送到远端。 【回调参数】 HWRtcAudioFrame：音频数据格式，具体请参见HWRtcAudioFrame。 【返回参数】 YES：处理结果成功。 NO：处理结果失败。