华为云用户手册

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消息。

onLocalVideoStatsNotify virtual void onLocalVideoStatsNotify(const HRTCLocalVideoStats *localStats, unsigned int localStatsCount) 【功能说明】 本地视频流详情，2s触发一次回调。 【回调参数】 localStats：本地视频收流统计，具体请参见HRTCLocalVideoStats。 localStatsCount：localStats数组长度。

onStreamPublishStateChange void onStreamPublishStateChange(int code, const char* taskId, const HRTCUrlStatusList * urlStatu); 【功能说明】 RTMP推流状态回调。 【回调参数】 code：错误码，成功为0，失败请参考错误码HRTCErrorCode。 taskId：任务Id。 urlStatu：推流的url状态，具体请参见HRTCUrlStatusList。

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为空指针，需要先判断不为空再使用，否则可能引发空指针错误。

onMultiRoomMediaRelayStateChanged void onMultiRoomMediaRelayStateChanged(const char *roomId, HRTCMultiRoomMediaRelayState state, HRTCMultiRoomMediaRelayStateCode code); 【功能说明】 跨房状态回调。 【回调参数】 roomId：跨房房间号。 state：状态类型，具体请参见HRTCMultiRoomMediaRelayState。 code：状态的具体原因，具体请参见HRTCMultiRoomMediaRelayStateCode。

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表示远端停止辅流。

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

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表示设备未静音。 通话前调整音频设备音量和静音会上报变化。

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：错误原因描述。

RtmpConfigModel 表77 RTMP推流设置参数模型 属性 类型 描述 width int 旁路推流的输出视频流的总宽度，单位为px。360为默认值，取值范围为[64-1920] height int 旁路推流的输出视频流的总高度，单位为px。640为默认值，取值范围为[64-1920] videoBitrate int 旁路推流的输出视频的码率，单位为Kbps。默认值为400Kbps，取值范围[32-2760]， videoFramerate int 旁路推流的输出视频的帧率，单位为fps。默认值为15，取值范围为 [10,30] videoGop int 用于旁路直播的输出视频的GOP，单位为帧。默认值为30帧，取值范围为[1-300] audioSampleRate int 用于旁路直播的输出音频的采样率，默认16000，取值范围为[16000-96000] audioBitrate int 旁路直播的输出音频的码率。单位为Kbps，默认值为48，最大值为128，取值范围为[1-128] audioChannels int 旁路直播的输出音频的声道数，默认1，取值范围为[1-5] tmplate int 0表示悬浮，1表示九宫格，2表示屏幕分享，默认为0

HRTCDstMultiRoomMediaInfo 表95 HRTCDstMultiRoomMediaInfo 属性 类型 描述 authorization const char* 目标跨房的鉴权信息 userId const char* 目标跨房的虚拟用户名 roomId const char* 目标跨房房间号 userRole HRTCRoleType 跨房角色 ctime long long 鉴权时间信息

HWRtcStartAudioFileParam 表80 音频文件参数 属性 类型 描述 fullFilePath NSString 音频文件路径 playMode HWRtcAudioFilePlayMode 播放模式 cycle NSUInteger 音频播放次数，0表示无限循环 replace NSUInteger 是否用音频文件替换麦克风采集的声音。1表示只使用音频文件发送到远端，0表示将本地麦克风采集并和音频文件混音后发送到远端

HRTCMultiRoomMediaRelayStateCode 表97 HRTCMultiRoomMediaRelayStateCode 属性 描述 HRTC_MULTI_ROOM_MEDIA_RELAY_OK 正常状态 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_SERVER_NO_RESPONSE 服务端无响应 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_INTERNAL_ERROR 服务器内部出错 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_USER_OVER_LIMIT 用户跨房超出限制数 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_OVER_LIMIT 房间跨房用户超出限制数 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_REQ_EMPTY 跨房请求消息体为空 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_OPERATION_CONFLICT 跨房请求，加入和退出存在冲突 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_SRC_USERINFO_INVALID 跨房请求原用户信息无效 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_WITH_ORI 跨房房间与原用户房间相同 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_REPEAT 跨房请求房间重复 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_USER_EXISTED 跨房用户已存在 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_INVALID_REQUEST 无效请求 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_ROOM_IS_NOT_EXIST 房间不存在 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_F RAM E_TYPE_NOT_EQUAL 跨房源房间和目的房间加密模式不一致 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_AUTHENTICATION_FAILURE 鉴权失败 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_REMOVE_INFO_NOT_EXIST 退出跨房信息不存在 HRTC_MULTI_ROOM_MEDIA_RELAY_ERROR_EXCEPTION_STOP 异常退出跨房

HWRtcVideoAuxiliarEncParam 表85 辅流编码能力 属性 类型 描述 frameRate NSInteger 编码帧率，推荐帧率15帧 width NSInteger 编码辅流宽。（iOS下根据宽，根据高按比例缩放） height NSInteger 编码辅流高。（iOS下如果屏幕宽度不超过1080，则视频源宽为720，否则为1080） bitrate NSInteger 码率，具体设置参考表56和表57。

HRTCMultiRoomMediaRelayState 表96 HRTCMultiRoomMediaRelayState 属性 描述 HRTC_MULTI_ROOM_MEDIA_RELAY_STATE_IDLE 就绪状态 HRTC_MULTI_ROOM_MEDIA_RELAY_STATE_CONNECTING 正在连接 HRTC_MULTI_ROOM_MEDIA_RELAY_STATE_RUNNING 主播成功加入目标房间 HRTC_MULTI_ROOM_MEDIA_RELAY_STATE_FAILURE 发生异常

HWRtcLocalVideoStats 表61 本端视频统计回调 枚举值 描述 @(strong, nonatomic) NSString *userId; 用户ID（本地视频信息为空） @ (assign, nonatomic) NSUInteger width; 视频宽 @ (assign, nonatomic) NSUInteger height; 视频高 @ (assign, nonatomic) NSUInteger bitRate; 视频码率 @ (assign, nonatomic) NSUInteger frameRate; 视频帧率 @ (assign, nonatomic) NSUInteger packetLoss; 视频丢包率 @ (assign, nonatomic) NSUInteger delay; 视频时延 @ (assign, nonatomic) NSUInteger jitter; 视频抖动 @ (assign, nonatomic) long long bytes; 字节数 @ (assign, nonatomic) NSUInteger sendFrameRate; 实际发送帧率，单位：fps

HWRTCEncryptionConfig 表68 加密配置 函数&属性 描述 @(strong, nonatomic) HWRTCCryptionMode cryptionMode; HWRTCCryptionMode加密模式 @(assign, nonatomic) HWRTCSuiteType suitType; HWRTCSuiteType加密算法，仅模式HWRTCCryptionModeAuthenticationSdk需要 @ (assign, nonatomic) NSString *cryptionSec; 加密密钥，仅模式HWRTCCryptionModeAuthenticationSdk需要设置 @ (assign, nonatomic) HWRTCCryptionSecFormat cryptionSecFormat HWRTCCryptionSecFormat ，密钥格式，当前只支持16进制字符串

HWRtcAudioFileReason 表60 音频播放状态变化原因 枚举值 描述 HWRtcAudioFileReasonNone 没有错误 HWRtcAudioFileReasonUrlNotFound 未找到URL HWRtcAudioFileReasonCodecNotSupported 解码器不支持该编码 HWRtcAudioFileReasonInvalidArguments 非法参数 HWRtcAudioFileReasonSrcBufferUnderflow 播放缓冲区数据不足 HWRtcAudioFileReasonInterval 内部错误 HWRtcAudioFileReasonInvalidState 播放器内部状态错误 HWRtcAudioFileReasonNoResource 没有该资源 HWRtcAudioFileReasonObjNotInitialized 对象未初始化 HWRtcAudioFileReasonInvalidConnectionState 播放器与服务器连接无效 HWRtcAudioFileReasonUnknowdStreamType 未知的媒体流类型 HWRtcAudioFileReasonVideoRenderFailed 渲染失败 HWRtcAudioFileReasonInvalidMediaSource 无效的媒体资源 HWRtcAudioFileReasonUnknown 状态未知

HWRtcAudioFileState 表59 音频文件播放状态 属性 描述 HWRtcAudioFileOpenCompleted 成功打开音频文件 HWRtcAudioFileOpening 正在打开音频文件 HWRtcAudioFileIdle 音频文件播放就绪 HWRtcAudioFilePlaying 音频文件播放中 HWRtcAudioFilePlayCompleted 音频文件播放完成 HWRtcAudioFilePaused 音频文件暂停播放 HWRtcAudioFileStopped 音频文件停止播放 HWRtcAudioFileFailed 音频文件播放失败 HWRtcAudioFilePositionUpdate 音频文件播放进度更新 HWRtcAudioFileStateUnknown 音频文件播放状态未知

HWRTCCryptionMode 表69 加密模式 枚举值 描述 HWRTCCryptionModeDefault 不开启端到端加密，此时srtp认证（包校验）+加密 HWRTCCryptionModeAuthenticationSdk 开启端到端加密，srtp只认证（包校验），sdk内部加密, 必现配置key HWRTCCryptionModeAuthenticationApp 开启端到端加密，srtp只认证（包校验），应用层加密，需注册回调