华为云用户手册

方案咨询（联通用户专用） 非联通用户请查看 设备接入服务 。 开发中心、设备接入和设备管理的差异是什么？ IAM 子用户或子项目是否可以开通 物联网平台 服务？ 物联网平台支持在华为云的哪些区域开通？ 如何成为华为IoT生态合作伙伴？ 物联网平台支持哪些接入方式和协议？ 华为是否提供模组/硬件终端/应用软件等？ 设备接入模拟器HubSimulator是否能在设备管理使用？ 设备接入服务如何获取设备数据？ 物联网平台的应用和设备可以无限创建吗？ 物联网平台支持批量注册设备吗？ 物联网平台对应用和设备有消息流控吗？ 开发中心单个应用允许接入设备数是多少？ 数据在物联网平台的保存时间是多久？ 物联网平台支持的DTLS加密算法有哪些？ 物联网平台支持二进制大小端模式切换吗？ 什么是NB-IoT？ 物联网平台支持的硬件架构和使用的相关组件有哪些？

setProxyServer setProxyServer(server: string): void 【功能说明】 设置信令代理服务器。用于企业内部部署反向代理服务器（如 nginx ）的场景。该方法为2.0.3版本新增。 【请求参数】 server：必选，string类型，反向代理服务器的列表。一个代理服务器的格式，比如：http://ip:port / https://domain:port。 【返回参数】 无 setProxyServer和setTurnServer方法需在join之前调用。

setTurnServer setTurnServer(turnServerConfig: TurnServerConfig): void 【功能说明】 设置代理服务器配置信息。用于企业内部部署反向代理服务器（如nginx）的场景。该方法为2.0.3版本新增。 【请求参数】 turnServerConfig：代理服务器配置信息。必选，TurnServerConfig类型。 TurnServerConfig 类型定义如下：{ turnServers：反向代理服务器地址。必选，string[]类型。 udpPort：UDP端口。可选，number类型。 userName：反向代理服务器用户名。可选，string类型。 credential：反向代理服务器密码。可选，string类型。 } 【返回参数】 无

getConnectionState getConnectionState(): ConnectionState 【功能说明】 获取客户端连接状态。 【请求参数】 无 【返回参数】 ConnectionState：webSocket的连接状态，string类型，取值如下： CONNECTING：连接建立中。 CONNECTED：连接已建立。 RECONNECTING：重新连接中。 DISCONNECTED：连接已断开。

setNetworkBandwidth setNetworkBandwidth(bandwidthParam: NetworkBandwidth): void 【功能说明】 设置媒体最大带宽。该方法为2.0.5版本新增。 【请求参数】 NetworkBandwidth类型定义如下：{ maxBandwidth：必选，number类型，媒体最大总带宽，取值范围为[3072, 51200]，单位为kbps。 } 【返回参数】 无

muteAudio4TopThree muteAudio4TopThree(enable: boolean): void 【功能说明】 开启音频TopN模式（最大三方模式）后，开启/禁用音频TopN模式的音轨。 【请求参数】 enable：必选，boolean类型，true表示禁用音频TopN模式的音轨，false表示开启音频TopN模式的音轨。默认为false。 【返回参数】 无 该接口需要在enableTopThreeAudioMode后设置，1.4.0版本新增。

renewSignature renewSignature(ctime: string, signature: string): boolean 【功能说明】 更新签名。 【请求参数】 ctime：签名鉴权的过期时间，是系统当前UTC时间（unix时间戳）加上鉴权过期时间（推荐2小时，最长需要小于12小时）。单位：秒。必选，string类型。 signature：签名，签名的具体生成方法请参见接入鉴权。必选，string类型，string[512]类型。 【返回参数】 boolean：返回一个boolean值，说明更新签名是否成功。 该接口2.0.8版本新增。

onVideoFrameRender virtual bool onVideoFrameRender(const char* userId, HRTCVideoFrame& videoFrame) 【功能说明】 原始视频数据处理后回调 【回调参数】 userid：用户ID videoFrame：视频数据格式 ，具体请参见HRTCVideoFrame。 【返回参数】 true：处理结果成功。 false：处理结果失败。

player-state-change 【事件说明】 播放状态变更事件。在播放状态变更的时候触发。 【回调参数】 event：playState类型。字段定义如下： type：string类型，表示播放器类型，取值为video/audio。 id：string类型，表示流分辨率Id。 state：string类型，表示当前播放状态。取值包括：PLAYING，STOPPED，PAUSED， NONE。 reason：string类型，表示触发播放状态变更的原因。

客户端错误码 本章节介绍了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 声音共享失败 声音共享失败 父主题： 接口参考

onDeviceVolumeChangedNotify virtual void onDeviceVolumeChangedNotify(HRTCDeviceType deviceType, unsigned int volume, unsigned int muted) 【功能说明】 音频设备音量发生变化，触发此回调。 【回调参数】 deviceType：系统设备类型，具体请参见HRTCDeviceType。 volume：音量 muted：true表示设备静音，false表示设备未静音。 通话前调整音频设备音量和静音会上报变化。

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

onUserVolumeStatsNotify virtual void onUserVolumeStatsNotify(const HRTCVolumeInfo* userVolumes, unsigned int userVolumesCount, unsigned int totalVolume) 【功能说明】 用户音量状态回调。通过enableUserVolumeNotify开启并设置回调周期，定时上报。 【回调参数】 userVolumes：用户信息，具体请参见HRTCVolumeInfo。 userVolumesCount：上报的用户人数，包含本地用户。 totalVolume：总音量。

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

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

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

onStartAllRemoteViewResult virtual void onStartAllRemoteViewResult(int errCode, const char* errMsg, unsigned int counts, const HR TCS etupRemoteViewResult* results) 【功能说明】 批量选看结果回调。 【回调参数】 errCode：错误码。 errMsg：错误信息。 counts：results数组大小。 results：批量选看结果，具体请参见HRT CS etupRemoteViewResult。

onUserRoleChangedNotify virtual void onUserRoleChangedNotify(const char* roomId, HRTCRoleType oldRole, HRTCRoleType newRole) 【功能说明】 用户角色切换成功，触发此回调。 【回调参数】 roomId：发生角色切换的房间号。 oldRole：切换前的角色。具体请参见HRTCRoleType。 newRole：切换成功后的角色。具体请参见HRTCRoleType。

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

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数组长度。

onRemoteMicrophoneStateChanged void onRemoteMicrophoneStateChanged(const char* userId, HRTCRemoteMicState state); 【功能说明】 远端麦克风设备状态变更通知。 【回调参数】 userId：远端用户userId。 state：麦克风设备状态，具体请参见HRTCRemoteMicState。

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

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

onRenderAuxiliaryExternalVideoFrame virtual void onRenderAuxiliaryExternalVideoFrame(const char* roomId, HRTCMediaDirection direction, const char* userId, HRTCVideoFrame& videoFrame) 【功能说明】 辅流自渲染回调。需要调用setAuxiliaryExternalVideoFrameOutput接口开启辅流自渲染，从而触发该回调。 【回调参数】 roomId：房间ID。 direction：数据源，本地数据，远端数据，具体请参见HRTCMediaDirection。 userId：用户ID。 videoFrame：辅流详情，具体请参见HRTCVideoFrame。

onLocalAudioStateChangedNotify virtual void onLocalAudioStateChangedNotify(HRTCLocalAudioStreamState state, HRTCLocalAudioStreamStateReason reason) 【功能说明】 本地音频状态改变，触发此回调。 【回调参数】 state：本地音频状态，具体请参见HRTCLocalAudioStreamState。 reason：本地音频状态改变的原因，具体请参见HRTCLocalAudioStreamStateReason。

onRemoteVideoStatsNotify virtual void onRemoteVideoStatsNotify(const HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】 远端视频流详情，2s触发一次回调。 【回调参数】 remoteStats：远端视频收流统计，具体请参见HRTCRemoteVideoStats。 remoteStatsCount：remoteStats数组长度。

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