检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除录制规则 功能介绍 调用此接口删除录制规则,对于正在使用的录制规则,不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
Windows 前提条件 已提交工单获取SDK包。 环境要求 准备集成开发环境,建议使用Microsoft Visual Studio 2015或以上版本。 支持Windows 7或以上版本的Windows设备。 支持的平台:x86 release。 资源文件列表 头文件目录 lib
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下: 客户端对象(Client)新增旁路推流接口:startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
Web SDK 浏览器适配 开发前准备 SDK使用 基本使用逻辑 接口参考 常见问题 修订记录
查询增值(录制)事件回调配置 功能介绍 调用此接口查询增值(录制)事件回调配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK
接口参考 主入口(HRTC) 客户端对象(Client) 客户端事件通知(ClientEvent) 流对象(Stream) 本地流对象(LocalStream) 远端流对象(RemoteStream) 流事件通知(RTCStreamEvent) 错误码(RtcError) 客户端错误码
配置RTC增值(录制)事件回调 功能介绍 调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调内容请参见增值(录制)事件回调通知内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
更新自动录制配置 功能介绍 更新自动录制配置,租户可以开启自动单流录制或者停用自动单流录制(仅支持单流录制)。 接口约束 开启自动单流录制功能之后,只针对新创建的房间有效,对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则: {appid}_{roomid}_
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/individual-stream-jobs
什么是Signature? 为保证RTC的通信安全,当用户加入频道时,华为云SparkRTC服务需要对其进行接入鉴权。 图1 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在相应的SDK的初始化或登录函数中提供“app_id”、“room_id”、“user_id
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix-stream-jobs
接入鉴权 为保证SparkRTC的通信安全,当用户加入房间时,华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在SDK加入房间时设置“