检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询录制规则 功能介绍 调用此接口查询指定录制规则。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules/{rule_id}
查询历史规模 功能介绍 查询指标过去每天的规模数量，可查询最近31天的数据。当天未结束，无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
设备管理 setSpeakerModel - (int)setSpeakerModel:(HWRtcSpeakerModel)speakerModel; 【功能说明】 设置声音播放模式。成功加入房间后才能调用。 【请求参数】 speakerModel：声音播放模式，具体请参见HWRtcSpeakerModel。
流对象（Stream） 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
若OBS服务欠费停服，将会导致实时音视频录制失败。建议您在录制启动前，确认OBS服务是正常服务的。 OBS服务会因欠费停服，从而导致实时音视频录制失败，建议您购买OBS存储包。 前提条件 已添加应用。 因录制生成的音视频文件是存储在OBS桶中的，因此，您需要先开通对象存储服务，具体请参见OBS快速入门。
音频管理 enableLocalAudioStream virtual int enableLocalAudioStream(bool enabled) 【功能说明】 设置是否开启本地麦克风音频采集。 【请求参数】 enable：true表示开启。false表示关闭。 【返回参数】
配置录制回调 SparkRTC服务提供了录制任务状态回调设置，支持配置HTTP/HTTPS URL，向用户服务器发送POST请求，将录制任务状态信息实时反馈到用户服务器。 回调协议 请求：HTTP POST请求，请求Body的内容为JSON格式。 应答：HTTP STATUS CODE
接收增值（录制）事件回调通知内容 SparkRTC服务回调用户提供的接口时，会附带以下信息。 表1 请求Body参数 参数 是否必选 参数类型 描述 job_id 否 String 任务编号，可以用于修改、查看和停止录制任务 stream_name 否 String 流名 app_id
房间功能 joinRoom public abstract int joinRoom(HRTCJoinParam joinParam); 【功能说明】 加入房间。 【请求参数】 joinParam：入会参数，具体请参见HRTCJoinParam。 【返回参数】 0：成功。 1：失败。
事件回调（HWRtcEngine） 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
音频设备管理 本章节介绍了全平台C++ SDK的IHRTCAudioDeviceManager接口详情。 表1 IHRTCAudioDeviceManager接口 接口 描述 getPlaybackDevices 获取系统音频播放设备列表 getRecordDevices 获取系统音频录制设备列表
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合，一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放，也可以同时播放给其他与会者听。 支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用步骤 实现过程 加入房间
查询OBS桶下对象列表 功能介绍 查询OBS桶下对象列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets/objects
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合，一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放，也可以同时播放给其他与会者听。 支持播放本地或在线音乐文件，文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现过程 加入房间
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合，一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放，也可以同时播放给其他与会者听。 支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用流程 实现过程 加入房间
接入鉴权 为保证SparkRTC的通信安全，当用户加入房间时，华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式，需要在SDK加入房间时设置
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
房间功能 joinRoom public abstract int joinRoom(HRTCJoinParam joinParam); 【功能说明】 加入房间。 【请求参数】 joinParam：入会参数，具体请参见HRTCJoinParam。 【返回参数】 0：成功。 1：失败。具体请参见客户端错误码。
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况，暂不支持查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/ap
事件回调（IHRTCEngine） 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
