检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能
图2 异常影响因素分布详情 异常类型：造成通话体验异常的类型，包含进房慢、视频卡顿和音频卡顿。 异常因素：造成通话体验异常的影响因素，具体请参见表1。 影响占比：某异常影响的用户数占总异常影响的用户数的比例。 影响用户数：某异常影响的用户数。 表1 影响因素说明 影响因素 检测阈值
Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。
设置是否开启摄像头采集视频。 【请求参数】 enable：YES表示开启，NO表示关闭。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 默认开启本地视频采集，关闭不会影响视频流发送。 远端用户订阅了本端用户时，会收到onRemote
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK内部系统错误
响应参数 状态码： 200 表7 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表8 响应Body参数 参数 参数类型 描述 job_id String 任务编号，可以用于修改、查看和停止合流任务 stream_name
设置是否关闭本地音频流发送。 【请求参数】 mute：YES表示关闭音频流发送，NO表示开启音频流发送。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 默认开启本地音频发流。 关闭本地音频发流，不影响本地音频采集。 远端用户订阅该用户时，远端用
状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表5 响应Body参数 参数 参数类型 描述 rules Array of RecordRule objects 录制规则列表 表6 RecordRule
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后，修改后的规则对正在录制的流无效。 修改后对新的流有效，生效时间为5分钟，即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API E
在“录制规则”页签，单击“添加”，进入添加录制规则页面。 一个应用ID仅支持创建一个录制规则。 请您按照实际需求配置录制参数，参数说明如表1所示。 表1 录制参数说明 参数名 描述 存储-桶 存储录制文件的OBS桶。 目前录制文件仅支持存储到华北-北京四的OBS桶中。 区域 OBS桶所在的区域。
3166-1的2位字母的国家码要求。表示业务接入点的国家码，SDK会根据设置将业务接入到对应区域的服务，如：CN表示中国大陆，US表示美国，HK表示中国香港。countryCode值的填写具体请参见国家码对照表。该参数为2.0.3版本新增，且为必选参数，从2.0.7版本开始，修改为可选参数。 } 【返回参数】
单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。 表1 初始化等基础接口 接口 描述 release 释放Connection setEncryption 设置端到端加密模式 setNetworkBandwidth 设置网络带宽限制 表2 房间功能接口 接口 描述 joinRoom 加入房间
setNetworkBandwidth 设置网络带宽限制 房间功能 表2 房间功能接口 接口 描述 joinRoom 加入房间 changeUserRole 设置用户的角色，切换角色时使用 changeUserName 修改用户昵称 getRoomId 获取房间id leaveRoom
状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表6 响应Body参数 参数 参数类型 描述 job_id String 任务编号 stream_name String 流名 app_id
075Z”，时区为：UTC 表7 RecordParam 参数 参数类型 描述 record_rule_id String 录制规则id。 状态码： 400 表8 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号，以便任务跟踪。 表9 响应Body参数
开启/关闭接收指定远端用户的视频流。只能加入房间后调用。 【请求参数】 userId: 远端用户的userId，唯一标识。 pull：true表示开启接收，false表示关闭接收。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HRTCErrorCode。 pullAllRemoteVideo
【请求参数】 userId：用户ID。 volume：音量值，取值范围为[0,100]，默认音量值为10无增益，10以下表示负增益，10以上表示正增益，此接口不会影响系统音量。 【返回参数】 0：成功。 >0：失败。具体请参见客户端错误码。 sendAudioSeiMsg public
播放音频文件，房间内调用。当前仅支持本端播放。 【请求参数】 filePath：音频文件的本地全路径。 publish：播放模式，0表示只有本端能听到播放的音频，1表示远端也能听到播放的音频。 cycle：循环次数，0表示无限循环。 replace：远端模式下面是否需要和麦克风做混音。 startPos：音频文件开始播放的位置，单位为ms。
【功能说明】 设置是否接收对应远端用户的音频流。 【请求参数】 userId：远端用户的userid，唯一标识。 muted：YES表示取消订阅，NO表示订阅。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 muteAllRemoteAudio
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下： 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下： 删除启动单流任务、更新单流任务和启动合
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
