华为云用户手册

HRTCAudioFileReason 表67 音频播放状态变化原因 枚举值 描述 HRTC_AUDIO_FILE_REASON_NONE 没有错误 HRTC_AUDIO_FILE_REASON_URL_NOT_FOUND 未找到URL HRTC_AUDIO_FILE_REASON_CODEC_NOT_SUPPORTED 解码器不支持该编码 HRTC_AUDIO_FILE_REASON_INVALID_ARGUMENTS 非法参数 HRTC_AUDIO_FILE_REASON_SRC_BUFFER_UNDERFLOW 播放缓冲区数据不足 HRTC_AUDIO_FILE_REASON_INTERNAL 内部错误 HRTC_AUDIO_FILE_REASON_INVALID_STATE 播放器内部状态错误 HRTC_AUDIO_FILE_REASON_NO_RESOURCE 没有该资源 HRTC_AUDIO_FILE_REASON_OBJ_NOT_INITIALIZED 对象未初始化 HRTC_AUDIO_FILE_REASON_INVALID_CONNECTION_STATE 播放器与服务器连接无效 HRTC_AUDIO_FILE_REASON_UNKNOWN_STREAM_TYPE 未知的媒体流类型 HRTC_AUDIO_FILE_REASON_VIDEO_RENDER_FAILED 渲染失败 HRTC_AUDIO_FILE_REASON_INVALID_MEDIA_SOURCE 无效的媒体资源 HRTC_AUDIO_FILE_REASON_UNKNOWN 状态未知

HRTCVideoRemoteView 表74 远端流视图 属性 描述 SurfaceView view 窗口句柄 HR TCS treamType streamType 流模式（LD/SD/HD/FHD/THD） String userId 用户ID boolean disableAdjustRes 是否自适应 HRT CS treamType minResolution 自适应场景下，建议的最低选择档位

HRTCMultiRoomMediaRelayState 表80 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 发生异常

HRTCOnStats 表65 引擎创建相关参数 属性 类型 描述 cpuAppUsage double app的cpu利用率，单位(%) cpuTotalUsage double cpu总利用率，单位(%) memoryAppUsageInKbytes int app占用内存，单位KB memoryAppUsageRatio double app占用的内存率，单位(%) memoryTotalUsageRatio double 总的内存利用率，单位(%) gatewayRtt int 到本地网关的延迟，单位ms sendBytes long 总的发送字节数，单位bytes sendVideoBytes long 视频的发送字节数，单位bytes sendAudioBytes long 音频的发送字节数，单位bytes receiveBytes long 总的接收字节数，单位bytes receiveVideoBytes long 视频的接收字节数，单位bytes receiveAudioBytes long 音频的接收字节数，单位bytes sendBitRate int 总的发送比特率，单位Kbps sendVideoBitRate int 视频的发送比特率，单位Kbps sendAudioBitRate int 音频的发送比特率，单位Kbps receiveBitRate int 总的接收比特率，单位Kbps receiveVideoBitRate int 视频的接收比特率，单位Kbps receiveAudioBitRate int 音频的接收比特率，单位Kbps sendLossRate int 发送丢包率，单位(%) receiveLossRate int 接收丢包率，单位(%) lastmileDelay int 到服务器的延迟，单位ms

HRTCEngineContext 表69 引擎初始化参数 属性 类型 描述 engineConfig HRTCEngineConfig 引擎配置项，具体请参见HRTCEngineConfig logConfig HRTCLogConfig 日志配置项，具体请参见HRTCLogConfig eventHandler IHRTCEngineEventHandler 事件回调，具体请参见IHRTCEngineEventHandler

HRTCNetworkQualityLevel 网络质量级别的数值越大，信号越好。 表46 网络质量级别 枚举值 描述 HRTC_NETWORK_QUALITY_UNKNOWN 网络质量未知 HRTC_NETWORK_QUALITY_EXCELLENT 网络质量非常好 HRTC_NETWORK_QUALITY_GOOD 网络质量好 HRTC_NETWORK_QUALITY_POOR 网络质量一般 HRTC_NETWORK_QUALITY_BAD 网络质量差 HRTC_NETWORK_QUALITY_VBAD 网络质量非常差

HRTCRemoteVideoStreamStateReason 表42 远端视频状态变化原因 枚举值 描述 HRTC_REMOTE_VIDEO_REASON_REMOTE_OFFLINE 远端用户离线 HRTC_REMOTE_VIDEO_REASON_REMOTE_MUTED 远端用户停止视频流发送 HRTC_REMOTE_VIDEO_REASON_REMOTE_UNMUTED 远端用户开启视频流发送 HRTC_REMOTE_VIDEO_REASON_LOCAL_MUTED 本端已取消选看远端视频流 HRTC_REMOTE_VIDEO_REASON_LOCAL_UNMUTED 本端已开启选看远端视频流

HRTCRemoteAudioStreamStateReason 表39 远端音频状态变化原因 枚举值 描述 HRTC_REMOTE_AUDIO_REASON_REMOTE_OFFLINE 远端用户离线 HRTC_REMOTE_AUDIO_REASON_REMOTE_MUTED 远端用户停止音频流发送 HRTC_REMOTE_AUDIO_REASON_REMOTE_UNMUTED 远端用户开启音频流发送 HRTC_REMOTE_AUDIO_REASON_REMOTE_FIRST_DECODED 远端用户音频解码第一帧

HRTCNetworkTestConfig 表44 网络探测参数 属性 类型 描述 userId String 必选，用户ID roomId String 房间ID，必选，建议值：userId+随机数拼接 signature String 必选，签名鉴权 ctime long 必选，时间戳 enableUplinkTest boolean 必选，是否开启上行流探测 enableDownlinkTest boolean 必选，是否开启上行流探测 expectedUplinkBitrate int 必选，用户期望的最高发送码率，单位为bps，范围为0以及 [100000, 5000000]，设为0表示由SDK指定最高码率 expectedDownlinkBitrate int 必选，用户期望的最高接收码率，单位为bps，范围为0以及 [100000, 5000000]，设为0表示由SDK指定最高码率

HRTCLocalAudioStreamStateReason 表54 本地音频状态变化原因 枚举值 描述 HRTC_LOCAL_AUDIO_REASON_ERROR_OK 本地音频流状态正常 HRTC_LOCAL_AUDIO_REASON_ERROR_FAILURE 本地音频流出错原因不明确 HRTC_LOCAL_AUDIO_REASON_ERROR_RECORD_FAILURE 本地音频流录制失败，建议您检查录制设备是否正常工作 HRTC_LOCAL_AUDIO_REASON_ERROR_STOP_FAILURE 关闭采集失败 HRTC_LOCAL_AUDIO_REASON_ERROR_AC CES S_DENIED 音频设备无法访问，可能是设备隐私权限设置问题 HRTC_LOCAL_AUDIO_REASON_ERROR_ON_EXCLUSIVE_MODE 音频设备处于独占模式，且被其他应用独占，可以通知用户取消独占模式 HRTC_LOCAL_AUDIO_REASON_ERROR_ENDPOINT_CREATE_FAILED 音频设备终端创建失败，音频设备被拔出，或者已重新配置，禁用，删除了音频硬件或关联的硬件资源不可用。使用其他音频设备，重启或者更新驱动(仅适用于windows) HRTC_LOCAL_AUDIO_REASON_ERROR_MMSYSERR_INVALPA RAM 音频设备API非法参数，目前已知是杀毒软件导致(仅适用于windows) HRTC_LOCAL_AUDIO_REASON_ERROR_MMSYSERR_NODRIVER 音频设备API返回无驱动，需要用户升级驱动(仅适用于windows) HRTC_LOCAL_AUDIO_REASON_ERROR_AUDIO_SERVER_NOT_RUNNING 用户windows audio服务未启动，或者启动失败(仅适用于windows) HRTC_LOCAL_AUDIO_REASON_ERROR__NO_DEVICE 没有设备(仅适用于windows) HRTC_LOCAL_AUDIO_REASON_ERROR__RESTART_FAILED 扬声器播放无数据，重启失败

HRTCLeaveReason 表37 离开房间原因 枚举值 描述 HRTC_LEAVE_REASON_USER_LEAVE_ROOM 用户主动离开 HRTC_LEAVE_REASON_SERVER_ERROR 服务器异常 HRTC_LEAVE_REASON_BREAKDOWN sfu服务故障 HRTC_LEAVE_REASON_SERVICE_UNREACHABLE 服务不可达 HRTC_LEAVE_REASON_INTERNAL_ERROR 内部错误 HRTC_LEAVE_REASON_KICKED_OFF 被踢 HRTC_LEAVE_REASON_SIGNATURE_EXPIRED 签名过期 HRTC_LEAVE_REASON_RECONNECT_FAILED 重连超时

HRTCEngineConfig 表63 引擎创建相关参数 属性 类型 描述 context Context 上下文 appId String 应用ID，只有App ID相同的应用程序才能进入同一个房间进行互动。appId获取方法请参见应用管理 countryCode String 国家码，具体请参见国家码对照表 logEnable boolean 日志是否输出到文件，true为输出到文件，false为不输出到文件 logLevel HRTCLogLevel 日志等级，取值为HRTC_ LOG _LEVEL_ERROR、HRTC_LOG_LEVEL_WARNING、HRTC_LOG_LEVEL_INFO或HRTC_LOG_LEVEL_DEBUG，默认为HRTC_LOG_LEVEL_DEBUG logPath String 日志路径，需调用方保证路径合法可用，rtc仅做基础校验 logSize int 日志大小，单位为字节，目前固定10*1024

HRTCConnChangeReason 表32 网络连接状态变化原因 枚举值 描述 HRTC_CONN_CHANGED_CONNECTING 正在连接 HRTC_CONN_CHANGED_JOIN_SUCCESS 加入房间成功 HRTC_CONN_CHANGED_RECONNECTING 重连中 HRTC_CONN_CHANGED_RECONNECT_SUCCESS 重连成功 HRTC_CONN_CHANGED_JOIN_FAILED 加入房间失败 HRTC_CONN_CHANGED_RECONNCET_FAILED 重连失败 HRTC_CONN_CHANGED_INTERRUPTED 连接中断 HRTC_CONN_CHANGED_KEEP_ALIVE_TIMEOUT 心跳超时 HRTC_CONN_CHANGED_LEAVE_ROOM 主动离开房间 HRTC_CONN_CHANGED_JOIN_ROOM_SERVER_ERROR 服务器异常 HRTC_CONN_CHANGED_SFU_BREAKDOWN sfu服务故障 HRTC_CONN_CHANGED_JOIN_ROOM_AUTH_FAILED 鉴权失败，appId或者签名错误 HRTC_CONN_CHANGED_JOIN_ROOM_AUTH_RETRY 鉴权失败，重试 HRTC_CONN_CHANGED_JOIN_ROOM_AUTH_CLOCK_SYNC 鉴权时间戳校验失败 HRTC_CONN_CHANGED_JOIN_ROOM_URL_NOT_RIGHT URL错误 400 HRTC_CONN_CHANGED_JOIN_ROOM_SERVICE_UNREACHABLE 服务不可达503 HRTC_CONN_CHANGED_INTERNAL_ERROR 内部错误 HRTC_CONN_CHANGED_KICKED_OFF 被踢出房间 HRTC_CONN_CHANGED_SIGNATURE_EXPIRED 签名过期 HRTC_CONN_REASON_USER_REMOVED 用户移除 HRTC_CONN_REASON_ROOM_DISMISSED 房间解散 HRTC_CONN_CHANGED_REGION_NOT_COVERED 区域未覆盖，所在区域不能提供SparkRTC服务。 HRTC_CONN_CHANGED_LOST 连接异常

HRTCLocalVideoStreamStateReason 表57 本地视频状态变化原因 枚举值 描述 HRTC_LOCAL_VIDEO_REASON_ERROR_OK 本地视频流状态正常 HRTC_LOCAL_VIDEO_REASON_ERROR_FAILURE 本地视频流出错原因不明确 HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_FAILURE 本地视频流录制失败，建议您检查录制设备是否正常工作 HRTC_LOCAL_VIDEO_REASON_ERROR_STOP_FAILURE 关闭采集失败 HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_DEVICE_NO_PERMISSION 没有摄像头权限 HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_DEVICE_BUSY 摄像头设备已占用 HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_APP_IN_BACKGROUND 应用处于后台 HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_OPEN_CAMERA_FAILED 打开摄像头设备失败 HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APP 应用窗口处于侧拉、分屏、画中画模式 (仅适用于iOS) HRTC_LOCAL_VIDEO_REASON_ERROR_CAPTURE_DEVICE_DISCONNECTED 本地视频采集设备未连接 (仅适用windows和macOS)

HRTCRemoteAudioStats 表19 远端音频流信息详情 属性 类型 描述 userId String 远端用户ID sampleRate int 音频采样率 channels int 音频频道数 recvVEL int 接收语音电平 bitRate int 音频码率 packetLoss int 音频丢包率 delay int 时延，单位：ms jitter int 抖动 bytes long 字节数 totalFrozenTime int 远端用户在加入房间后到离开房间前，发生音频卡顿的累计时长，单位：ms frozenRate int 远端用户在加入房间后到离开房间前，发生音频卡顿的累计时长占音频总有效时长的百分比，单位：%

HRTCConnStateTypes 表31 网络连接状态 枚举值 描述 HRTC_CONN_DISCONNECTED 连接断开 HRTC_CONN_CONNECTING 建立网络连接中 HRTC_CONN_CONNECTED 网络连接成功 HRTC_CONN_RECONNETING 重新建立网络连接中 HRTC_CONN_FAILED 网络连接失败 HRTC_CONN_LOST 网络连接异常 HRTC_CONN_INTERRUPTED 网络连接中断

HRTCLocalVideoStats 表16 本地视频流信息详情 属性 类型 描述 width int 视频宽 height int 视频高 bitRate int 视频码率 frameRate int 视频帧率，单位：fps packetLoss int 视频丢包率 delay int 时延，单位：ms jitter int 抖动 bytes long 字节数 sendFrameRate int 实际发送帧率，单位：fps

HRTCRemoteVideoStats 表18 远端视频流信息详情 属性 类型 描述 userId String 远端用户userId width int 视频宽 height int 视频高 bitRate int 视频码率 frameRate int 视频帧率，单位：fps packetLoss int 视频丢包率 delay int 时延，单位：ms jitter int 抖动 bytes long 字节数 rendererOutputFrameRate int 渲染帧率，单位：fps totalFrozenTime int 远端用户在加入房间后到离开房间前，发生视频卡顿的累计时长，单位：ms frozenRate int 远端用户在加入房间后到离开房间前，发生视频卡顿的累计时长占视频总有效时长的百分比，单位：%

HRTCStatsInfo 表11 统计信息 属性 类型 描述 mildlyFrozenCounts long 600ms卡顿次数 severelyFrozenCounts long 超过1s卡顿次数 totalMildlyFrozenTime long 600ms卡顿总时长 totalSeverelyFrozenTime long 1s卡顿总时长 totalActiveTime long 总时间，包括每一路选看的视频流启动到停止的时间总和

HRTCVideoEncParam 表12 视频编码参数属性说明 属性 类型 描述 streamType HRTCStreamType 视频流类型，根据HRTCStreamType和表14 不同分辨率下帧率和码率的推荐值设置需要的分辨率和宽高比 width int 视频宽度 height int 视频高度 frameRate int 视频帧率，可参考表14中的帧率进行设置 minFrameRate int 视频最小帧率，大于等于0，小于等于frameRate bitRate int 视频码率，可参考表14中的码率进行设置 minBitrate int 视频最小码率，大于等于0，小于等于bitrate 表13 视频编码参数方法说明 方法 描述 public HRTCVideoEncParam(HRTCStreamType streamType, int width, int height, int frameRate, int minFrameRate, int bitrate, int minBitrate)； 【功能说明】 HRTCVideoEncParam构造函数。 【请求参数】 streamType：视频流类型，具体请参见HRTCStreamType。 width：视频宽度。 height：视频高度。 frameRate：视频帧率。 minFrameRate：视频最小帧率。 bitrate：视频码率。 minBitrate：视频最小码率。 【返回参数】 HRTCVideoEncParam类对象。 public HRTCStreamType getStreamType()； 【功能说明】 获取视频流类型。 【请求参数】 无 【返回参数】 视频流类型，具体参见HRTCStreamType。 public void setStreamType(HRTCStreamType streamType)； 【功能说明】 设置视频流类型。 【请求参数】 streamType：流类型，具体请参见HRTCStreamType。 【返回参数】 视频流类型，具体参见HRTCStreamType。 表14 不同分辨率下帧率和码率的推荐值 分辨率 分辨率类型 比例 最小帧率（fps） 最大帧率（fps） 最小码率 最大码率 160 X 90 LD 16:9 10 30 64 270 320 X 180 SD 16:9 10 30 80 600 480 X 270 HD 16:9 10 30 160 1050 640 X 360 HD 16:9 10 30 200 1700 800 X 450 FHD 16:9 10 30 300 2100 960 X 540 FHD 16:9 10 30 400 2400 1120 X 630 FHD 16:9 10 30 450 2800 1280 X 720 FHD 16:9 10 30 500 4000 120 X 90 LD 4:3 10 30 64 240 160 X 120 SD 4:3 10 30 64 270 240 X 180 SD 4:3 10 30 80 450 320 X 240 HD 4:3 10 30 100 600 400 X 300 HD 4:3 10 30 200 900 480 X 360 HD 4:3 10 30 200 1000 640 X 480 FHD 4:3 10 30 250 1800 960 X 720 FHD 4:3 10 30 450 3000 表15 不同场景下帧率和码率的推荐值 分辨率 推荐帧率 通信场景推荐码率 直播场景推荐码率 160 X 90 15 90 180 320 X 180 15 200 400 480 X 270 15 350 700 640 X 360 15 450 900 640 X 360 30 850 1700 800 X 450 15 700 1400 800 X 450 30 1050 2100 960 X 540 15 850 1700 960 X 540 30 1200 2400 1120 X 630 15 950 1900 1120 X 630 30 1400 2800 1280 X 720 15 1200 2400 1280 X 720 30 2000 4000 120 X 90 15 80 160 160 X 120 15 90 180 240 X 180 15 150 300 320 X 240 15 200 400 400 X 300 15 300 600 480 X 360 15 350 700 480 X 360 30 500 1000 640 X 480 15 600 1200 640 X 480 30 900 1800 960 X 720 15 1000 2000 960 X 720 30 1500 3000

HRTCUserInfo 表8 用户信息 属性 类型 描述 userId String 用户ID userName String 用户名，UTF-8编码格式，可选。 ctime long 签名时间戳，单位秒，有signature时必选。 signature String 签名，可选，具体生成方法请参见接入鉴权。 role HRTCRoleType 角色 optionalInfo String 可选JSON字串[{key:param1,value:value1},{key:param2,value:value2}]

HRTCEncryptionConfig 表5 端到端加密参数 属性 类型 描述 cryptionMode HRTCCryptionMode 加密模式 cryptionSec String 加密密钥，仅sdk加密模式下需要设置。必须是长度大于等于32的16进制字符串。 suiteType HRTCSuiteType 加密算法，当前仅支持HRTC_ENCRYPTION_128_CTR，sdk加密模式下需要设置 secFormat HRTCCryptionSecFormat 密钥格式，当前只支持16进制字符串。

HRTCJoinParam 表9 入会参数 属性 类型 描述 userId String 用户ID，支持最大长度64，支持数字、字母大小写、下划线、中线、"."字符。 userName String 用户名，UTF-8编码格式，可选，支持最大长度128。 ctime long 签名时间戳，单位秒，有signature时必选。 authorization String 签名，必填，鉴权私钥请在应用管理中获取。签名的具体生成方法请参见接入鉴权。支持最大长度为1024。 role HRTCRoleType 角色。 optionalInfo String 可选JSON字串[{key:param1,value:value1},{key:param2,value:value2}] roomId String 房间Id，支持最大长度64，支持数字、字母大小写、下划线、中线字符。 autoSubscribeVideo boolean 是否自动订阅视频。 autoSubscribeAudio boolean 是否自动订阅音频。 scenario HRTCRemoteAudioMode 使用的场景。 0：主动订阅（默认）。 1：TopN（千人）。 2：P2P。 3：RTSA CMD自动订阅。

服务端错误码 当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 已存在辅流共享 用户使用问题 父主题： 接口参考

SDK使用 创建引擎并初始化。 域名 不需要设置，由SDK自动获取。appId获取方法请参见创建应用。 1 2 3 4 5 6 7 8 9101112 _rtcEngine = [HWRtcEngine sharedEngine];HWRtcEngineConfig * cfg = [[HWRtcEngineConfig alloc]init];cfg.appId = appid;// appId需在控制台中创建应用后获取cfg.domain = domain;// 该字段已废弃，不需要再传值cfg.countryCode = rtcCountryCode;// 可以根据Grs国家码对照表传值，建议传"CN"cfg.enableHaTrace = YES;cfg.logLevel = HWRtcLogLevelDebug;//输出DEBUG级别日志cfg.logPath = [NSString stringWithFormat:@"%@/",logFilePath];//日志存储路径cfg.enableLog = YES;//开启日志cfg.logSize = 10*1024;cfg.muteAudioRoute = NO;//远端音频路由[_rtcEngine initWithConfig:cfg]; 设置本地窗口。 12345 HWRtcVideoCanvas *canvas = [[HWRtcVideoCanvas alloc] init]; canvas.view = [[UIView alloc] initWithFrame:CGRectMacke(0, 0, 90, 160)];//iOS//canvas.view = [[NSView alloc] initWithFrame:NSMakeRect(0, 0, 90, 160)];//macOScanvas.uid = @"HW"; [_rtcEngine setupLocalVideo:canvas viewMode:HWRtcVideoDisplayModeFit]; 加入房间。 1 2 3 4 5 6 7 8 9101112 HWRtcJoinParam *joinParam = [[HWRtcJoinParam alloc]init];NSString *authorization = @"";// 鉴权信息joinParam.role = HWRtcRoleJoiner;joinParam.userId = @"HW"; // userId用于标识同一房间的不同用户joinParam.userName = @"HW";// 用户昵称，如无特殊需求，保持和userId一致即可joinParam.scenario = 1;joinParam.authorization = authorization;joinParam.ctime = time;joinParam.roomId = roomid;joinParam.autoSubscribeAudio = YES;//是否主动订阅音频joinParam.autoSubscribeVideo = NO ;//默认-关闭BOOL result = [self.rtcEngine joinRoom:joinParam ]; joinParam：入会参数，包含用户ID、用户名、房间号、认证信息、ctime、是否自动订阅音频和视频、SFU类型、场景和用户角色，具体请参见HWRtcJoinParam。 监听远端用户加入房间，并设置远端窗口。 1 2 3 4 5 6 7 8 9101112131415161718192021 -(void)onRemoteUserOnline:(NSString*)roomId userId:(NSString*)userId userName:(NSString*)userName{ if([userId isEqualToString:localUid]){ return; } dispatch_async(dispatch_get_main_queue(), { UIView *videoView = [[UIVIew alloc] initWithFrame:CGRectMake(0, 0, 90, 160)];//iOS //NSView *videoView = [[NSView alloc] initWithFrame:NSMakeRect(0, 0, 90, 160)];//macOS [self.view addSubview:videoView]; HWRtcVideoCanvas *canvas = [[HWRtcVideoCanvas alloc] init]; canvas.uid = userId; canvas.view = videoView; int result = [self.rtcEngine startRemoteStreamView:canvas treamType:self.streamType]; if (result == 0) { [self.rtcEngine updateRemoteRenderMode:userId displayMode:HWRtcVideoDisplayModeFit mirrorMode:HWRtcVideoMirrorTypeDisable ]; } [self.viewsArray addObject:canvas]; }); } 监听远端用户离开房间，并删除远端窗口。 1 2 3 4 5 6 7 8 91011 - (void)onRemoteUserOffline:(NSString *)roomId userId:(NSString *)userId reason:(NSInteger)reason{ dispatch_async(dispatch_get_main_queue(), ^{ for (HWRtcVideoCanvas * canvas in self.viewsArray) { if ([userId isEqualToString:canvas.uid]) { [self.viewsArray removeObject:canvas]; } } });} 离开房间。 [_rtcEngine leaveRoom]; 父主题： iOS/macOS SDK

修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第十八次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay：停止所有跨房 新增以下事件回调： onRemoteMicrophoneStateChanged：远端麦克风设备状态变更通知 onUserNetworkQualityNotify：用户级网络质量回调 新增以下数据类型： HWRtcRemoteMicState：麦克风设备状态 HRTCMultiRoomMediaRelayConfiguration：跨房配置 HRTCSrcMultiRoomMediaInfo：源房间信息 HRTCDstMultiRoomMediaInfo：目标房间信息 HRTCMultiRoomMediaRelayState：跨房状态 HRTCMultiRoomMediaRelayStateCode：跨房状态码 2022-03-24 第十七次正式发布 本次变更如下： 修改appid获取方式的相关描述。 2022-03-18 第十六次正式发布 本次变更如下： 新增setNetworkBandwidth接口 2022-02-25 第十五次正式发布 本次变更如下： 修改接口：HRTCVideoDisplayMode去掉自适应HRTC_VIDEO_DISPLAY_MODE_ADAPT 2021-12-02 第十四次正式发布 本次变更涉及部分API的描述优化，具体请参见接口参考。 2021-11-22 第十三次正式发布 本次变更涉及部分API的逻辑优化与融合，如joinRoom、onConnectionChangedNotify、pushLocalVideo等，具体请参见接口参考。 2021-08-13 第十二次正式发布 本次发布版本为1.10.0版本，整合了之前若干版本和分支的一个全新版本。 本次变更如下： 新增joinRoom、adjustPlaybackVolume接口。 2021-06-10 第十一次正式发布 本次发布版本为1.8.0版本，整合了之前若干版本和分支的一个全新版本。 本次变更如下： 新增的接口及回调： changeUserName、onRemoteUserNameChangedNotify、onUserNameChangedNotify ：会议中修改用户昵称的接口及本地和远端会收到的回调。 createConnection：加入多房间（跨房）前，与要跨入的房间先建立连接的接口，跨一个房间建立一个连接。 setDefaultSpeakerModel：设置默认的声音播放模式。 onMediaConnectStateChangedNotify：增加与媒体服务器连接状态变化的通知回调。 onFirstRemoteAuxiliaryStreamDecoded：引擎收到第一帧远端辅流并解码成功的回调。 新增了接口对象和对应事件回调： HRTCConnection 事件回调(IHRTCConnectionEventHandler) 废弃的接口及回调： connectOtherRoom、onConnectOtherRoom、disconnectOtherRoom、onDisconnectOtherRoom：上述的两个接口及其对应的回调在1.8.0版本中予以废弃。新的跨房通过创建HRTCConnection与对应房间先建立连接，然后通过调用该对象的joinRoom和leaveRoom接口实现跨房和退房功能，对应回调处理通过事件回调(IHRTCConnectionEventHandler)中的onJoinRoomSuccess、onJoinRoomFailure、onLeaveRoom实现。 2021-01-28 第十次正式发布 本次变更如下： HRtcEngine新增接口：getVersion 2020-12-23 第九次正式发布 本次变更如下： HRtcEngine新增接口：updateLocalRenderMode、enableSmallVideoStream、setPriorRemoteVideoStreamType、setRemoteVideoStreamType、setRemoteVideoAdjustResolution、setupRemoteView、pullRemoteVideo、pullAllRemoteVideo、renewAuthorization、enableLocalAudioStream、 新增事件回调：onFirstRemoteVideoDecoded、onAuthorizationExpired 新增数据类型：HRTCVideoStreamType、HRTCVideoEncodeResolutionMode HRTCErrorCode增加90000043~90000045错误码 2020-11-26 第八次正式发布 本次变更如下： 新增数据类型：RTCMediaDirection 新增SparkRTC接入鉴权方法说明 2020-11-18 第七次正式发布 本次变更如下： HRtcEngine新增接口：setAuxiliaryExternalVideoFrameOutputEnable 2020-10-21 第六次正式发布 本次变更如下： HRtcEngine新增接口：startNetworkTest、stopNetworkTest、enableStats 新增事件回调：onUserVolumeStatsNotify、onStartAudioFileNotify、onStopAudioFileNotify、onPauseAudioFileNotify、onResumeAudioFileNotify、onNetworkTestQuality、onNetworkTestResult 新增数据类型：HRTCVolumeInfo、HRTCNetworkTestConfig、HRTCNetworkTestResult、HRTCNetworkQualityLevel、HRTCNetworkTestState、HRTCNetworkTestResultParam 2020-09-04 第五次正式发布 本次变更如下： 增加视频镜像接口：，setVideoEncoderMirror 增加音视频流采集发流控制接口及流状态变化回调：enableLocalVideo，onRemoteAudioStateChangedNotify，onRemoteVideoStateChangedNotify 增加重连成功回调接口onRejoinRoomSuccess HRtcErrorCode增加90000040~90000042错误码 增加HRTCLeaveReason，HRTCVideoMirrorType，HRTCRemoteAudioStreamState，HRTCRemoteAudioStreamStateReason，HRTCRemoteVideoStreamState，HRTCRemoteVideoStreamStateReason枚举 2020-08-17 第四次正式发布 本次变更如下： 增加选看跨房功能接口及回调：connectOtherRoom，disconnectOtherRoom，onConnectOtherRoom，onDisconnectOtherRoom 增加音频流接收选择接口：muteRemoteAudio，muteAllRemoteAudio 增加音视频流统计信息上报：onVideoStatsNotify，onAudioStatsNotify，onAuxiliaryStreamStatsNotify、onConnectOtherRoom、onDisconnectOtherRoom HRtcErrorCode增加90000034~90000039错误码 服务端错误码增加RTC.32000030~RTC.32000033错误码 增加HRTCVideoFrameFormat枚举类 2020-07-03 第三次正式发布 本次变更如下： 选看远端接口修改为startRemoteStreamView，updateRemoteRenderMode，stopRemoteStreamView 增加辅流相关接口startRemoteAuxiliaryStreamView，stopRemoteAuxiliaryStreamView，setRemoteAuxiliaryStreamViewRotation，updateRemoteAuxiliaryStreamRenderMode 修改错误码等 2020-06-20 第二次正式发布 本次变更如下： SDk集成中，修改需要添加的库文件。 修改接口参考中的类、方法等内容，具体如下： HRtcEngine类增加adjustRecordingVolume、adjustPlaybackVolume、setVideoEncoder、changeUserRole等方法增加。 新增结构体LocalVideoStats、RemoteVideoStats、StatsInfo、VideoEncoder。 IHRtcEngineEventHandler类增加onJoinRoomFailure、onUserRoleChangedNotify、onAudioRouteStateChangedNotify和onVideoStatsNotify方法。 RtcErrorCode增加90000019~90000030的错误码。 修改并增加服务端错误码。 增加RoleType枚举类。 ConnChangeReason枚举类增加枚举值成员。 2020-04-15 第一次正式发布 父主题： Android SDK

createConnection - (HWRtcConnection *_Nullable)createConnection:(NSString *_Nullable)roomId; 【功能说明】 根据房间ID，创建HWRtcConnection对象，为跨房做准备。 通过此接口创建一个与房间关联的HWRtcConnection连接对象。 该方法支持多次调用，创建多个HWRtcConnection连接对象，调用每个对象中的joinRoom方法，可以同时加入到多个房间。在每个房间中，可以分别订阅和选看房间中的用户。 具体请参见事件回调（HWRtcConnection）有关接口和回调。 【请求参数】 roomid：房间ID。 【返回参数】 HWRtcConnection：成功返回连接对象指针，失败返回为空。 同一时间最多只能创建4个连接对象，每个连接对象对应的房间ID必须互不相同。 如果使用HWRtcConnection对象加入房间，则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。 同一时间只能以JOINER角色加入某一个房间。

客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 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_PARAM_ERROR 90000005 参数错误 包括如下两方面： 接口入参无效； 内部参数错误。 HRTC_ERR_CODE_API_CALLED_IN_WRONG_ORDER 90000006 API调用顺序不当 当前只有日志设置必须在初始化之前。 HRTC_ERR_CODE_SETUP_LOCAL_VIEW_FAIL 90000007 设置本地窗口失败 内部窗口占用太多，无法再设置本地窗口。 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，超过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_AUTH_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 不允许角色切换 跨房时本房间内角色切换失败，通过onConnectOtherRoom返回。 HRTC_ERR_CODE_EXT_MEDIA_CAPTURE_INPUT 90000037 当前为第三方采集模式，禁用该操作 处于第三方采集模式下，修改视频输入设备时，上报此错误码。 HRTC_ERR_CODE_SET_EXTAUDIO_CAPTURE_FAIL 90000038 设置第三方音频采集失败 已经加入房间后，调用setExternalAudioCapture接口，会上报此错误码。 HRTC_ERR_CODE_SET_EXTVIDEO_CAPTURE_FAIL 90000039 设置第三方视频采集失败 已经加入房间后，调用setExternalVideoCapture接口，会上报此错误码。 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_LOCAL_AUDIO_DISABLE_FAIL 90000056 当前未推音频流 当前未推音频流。 HRTC_ERR_COD_ROLE_NOT_SUPPORT 90000057 当前用户角色不支持 当前用户角色不支持该操作。 HRTC_ERR_CODE_NOT_INCLUDE_MLSDK 90000058 没有动态加载ML图像分割库，不能支持背景虚化和背景替换能力 没有动态加载ML图像分割库，不能支持背景虚化和背景替换能力。 HRTC_ERR_CODE_ENABLE_BACKGROUND_FAIL 90000059 背景虚化或背景替换开启失败 背景虚化或背景替换开启失败。 父主题： 接口参考

常见问题 初始化引擎时，countryCode应该如何填写？ countryCode表示区域码，如果对应的是GLOBAL类型，则直接填空字符串，即""，如果是CN类型，则可以填"CN"。具体请参见国家码对照表。 初始化引擎时，domain应该如何填写？ 该字段已废弃，不需要再传值。 加入房间时，username必须填吗？ 必填。 应用关闭鉴权时，加入房间还需要填鉴权参数吗？ 不需要填。 加入房间失败时，如何解决？ 首先通过返回的客户端错误码进行分析，主要有以下几个原因： 网络问题，您需要确认网络是否正常运行。 鉴权问题，应用默认开启鉴权，您需要确保鉴权生成正确，参数合理传入，且保证没过期，需要注意ctime参数的设置，具体可参考接入鉴权。 参数问题，确认关键参数是否填写，以及是否正确填写，比如username是必填的，countryCode无特殊需求，则填空字符串。countryCode填写请参见国家码对照表。 如何进行屏幕共享？ 可以参考屏幕共享场景，按照正确时序使用API。 如何进行视频自渲染显示正常图像？ 在开启自渲染后，通过onRenderExternalVideoFrame接口接收SDK回调的图像信息，需要自行解析其中的图像信息，包括尺寸、格式、数据。以YUV格式举例，SDK返回的YUV格式是YUV420，故Y、U、V三分量需要按照下面的方式获取： ByteBuffer buffer = videoFrame.getBuffer();byte[] data = new byte[buffer.limit];buffer.get(data);byte[] yData = new byte[width * height];System.arraycopy(data, 0, yData, 0, width * height);byte[] uData = new byte[width * height / 4];System.arraycopy(data, width * height, uData, 0, width * height / 4);byte[] vData = new byte[width * height / 4];System.arraycopy(data, width * height * 5 / 4, vData, 0, width * height / 4); 得到YUV数据后，可以选择OpenGL或者其他能够播放YUV格式图像的方式进行渲染 父主题： Android SDK

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