检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
流事件通知(RTCStreamEvent) 本章节介绍了Web SDK的RTCStreamEvent事件。 表1 StreamEvent事件 接口 描述 player-state-change 播放状态变更事件。 screen-sharing-stopped 共享屏幕停止事件。 audio-mixing-played
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Exp
SparkRTC UserID是什么?取值范围是多少? UserID是实时音视频服务用来区分应用中用户的唯一标识。 用户标识是用户在实时音视频服务中的一个表示,开发者按照规范自定义UserID。 命名规则:可自定义,支持64个字节的大小写字母、数字、下划线(_)中划线(-)随机组合。
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。
版本规划 本章节为您介绍实时音视频服务(SparkRTC)客户端SDK的版本支持机制。 版本号说明 版本号格式为a.b.c.d,其中: a为大版本号:在版本架构重构的情况下更新。 b为小版本号:在重大特性或接口变更的情况下更新。 c为月度开发版本号:月度累加。 d为release
文档基本使用技巧 技巧1:基本使用逻辑说明 用时序图展示各端接口使用顺序,单击相应接口可以快速查看相关接口使用方法。 技巧2:接口总览说明 包括SparkRTC接口总体功能流程图和接口列表,根据功能分类可以快速查找具体功能单个接口,方便接口对接。 技巧3:单个接口使用须知 接口使
自动诊断 您可以实时查看应用下所有通话体验异常的用户信息及异常明细数据,快速识别通话异常的类型和影响因素。 注意事项 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。 支持查询的时间跨度最长为24小时。 操作步骤 登录实时音视频控制台。
实时数据 您可以查看音视频通话的规模、体验、网络指标的实时数据和分析图表,实时掌握项目整体动态,及时识别异常通话体验和异常根因。 注意事项 “实时数据”中的数据仅供数据分析和质量问题查询,计费数据请以账单为准。 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。
查询历史质量 功能介绍 查询质量指标过去每天的体验数据,可查询最近31天的数据。当天未结束,无法查询到当天的体验数据。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
流对象(Stream) 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流。
更新自动录制配置 功能介绍 更新自动录制配置,租户可以开启自动单流录制或者停用自动单流录制(仅支持单流录制)。 接口约束 开启自动单流录制功能之后,只针对新创建的房间有效,对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则: {appid}_{roomid}
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
删除录制规则 功能介绍 调用此接口删除录制规则,对于正在使用的录制规则,不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/r
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{ro
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
OBS桶授权及取消授权 功能介绍 OBS桶授权及取消授权。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/rtc-ops/buckets/authentication
查询增值(录制)事件回调配置 功能介绍 调用此接口查询增值(录制)事件回调配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-callback