检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
onJoinSuccess：加入房间成功。 onRemoteUserOnline：用户收到当前用户加入房间的通知。 onJoinRoomFailure：加入房间失败。
enableStats 打点功能开关 getVersion 获取当前SDK版本号 setEncryption 设置端到端加密模式 setAccessResourceType 设置接入环境 setNetworkBandwidth 设置网络带宽限制 房间功能 表2 房间功能接口 接口
signature: signature, ctime: ctime, role: role } async joinRoom() { try{ await client.join(roomId, option) console.log('join room success
disconnectOtherRoom、onDisconnectOtherRoom：新跨房通过与对应房间先建立连接HWRtcConnection，再通过连接调用其下的joinRoom和leaveRoom接口实现跨房和退房功能，回调亦通过HWRtcConnection下属回调OnJoinRoomSuccess
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
sharedEngine 创建连麦引擎实例 destroy 注销引擎 initWithConfig 初始化引擎配置信息 logUpload 上传日志 setEnableRtcStats 打点开关 getVersion 获取SDK版本号 setEncrytionParam 设置端到端加密模式 setAccessResourceType
流事件通知（RTCStreamEvent） 本章节介绍了Web SDK的RTCStreamEvent事件。 表1 StreamEvent事件 接口 描述 player-state-change 播放状态变更事件。 screen-sharing-stopped 共享屏幕停止事件。 audio-mixing-played
加入房间成功 HWRtcConnChangeReconnecting 重连中 HWRtcConnChangeReconnectSuccess 重连成功 HWRtcConnChangeJoinFailed 加入房间失败 HWRtcConnChangeReconncetFailed
获取系统音频设备管理对象 √ √ √ √ getVideoDeviceManager 获取系统视频设备管理对象 √ √ √ √ setJniLoadParams 设置jvm context 仅安卓使用 × × × √ setEncryption 设置端到端加密模式 √ √ √ √ setAccessResourceType
加入房间成功 HRTC_CONN_CHANGED_RECONNECTING 重连中 HRTC_CONN_CHANGED_RECONNECT_SUCCESS 重连成功 HRTC_CONN_CHANGED_JOIN_FAILED 加入房间失败 HRTC_CONN_CHANGED_RECONNCET_FAILED
HRTC_CONN_CHANGED_JOIN_SUCCESS 加入房间成功。 HRTC_CONN_CHANGED_RECONNECTING 重连中。 HRTC_CONN_CHANGED_RECONNECT_SUCCESS 重连成功。
配置RTC增值（录制）事件回调 功能介绍 调用此接口配置增值（录制）事件上报回调。 当任务发生订阅了的事件时，通过该接口配置的回调地址通知。 回调内容请参见增值（录制）事件回调通知内容。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
接收增值（录制）事件回调通知内容 SparkRTC服务回调用户提供的接口时，会附带以下信息。 表1 请求Body参数 参数 是否必选 参数类型 描述 job_id 否 String 任务编号，可以用于修改、查看和停止录制任务 stream_name 否 String 流名 app_id
常见问题 加入房间时，userName必须填吗？ 非必填。userName、userId由App自定义，但可以相同。 userId：必填，string[64]类型，用户标识，userId需要保证应用内唯一。userId支持的字符包括：a-z、A-Z、0-9、连接符 '-'、下划线
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RTC.00001001 OperationUnauthorized: get DomainID fail please check X-Auth-Token
隐私声明 华为云SparkRTC SDK是由华为云计算有限公司（以下简称“我们”或“华为云”）面向华为云客户提供，方便用户接入实时音视频。华为云客户根据开发文档和用户指南，在其应用中集成SparkRTC SDK后，我们将通过被集成的SparkRTC SDK向华为云客户面向的最终用户
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
配置录制规则 SparkRTC服务支持将实时音视频互动内容进行录制并将录制的内容存储到OBS桶中，您可以在OBS服务中对录制的音视频文件进行下载、分享等处理。相关操作流程，如图1所示。 图1 录制流程图 创建桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
