检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms
查询实时规模 功能介绍 获取规模相关的指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
查询增值(录制)事件回调配置 功能介绍 调用此接口查询增值(录制)事件回调配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id
查询历史规模 功能介绍 查询指标过去每天的规模数量,可查询最近31天的数据。当天未结束,无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
更新自动录制配置 功能介绍 更新自动录制配置,租户可以开启自动单流录制或者停用自动单流录制(仅支持单流录制)。 接口约束 开启自动单流录制功能之后,只针对新创建的房间有效,对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则: {appid}_{roomid}_
配置RTC增值(录制)事件回调 功能介绍 调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调内容请参见增值(录制)事件回调通知内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
常见问题 初始化引擎时,countryCode应该如何填写? countryCode表示区域码,如果对应的是GLOBAL类型,则直接填空字符串,即"",如果是CN类型,则可以填"CN"。具体请参见国家码对照表。 初始化引擎时,domain应该如何填写? 该字段已废弃,不需要再传值。
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在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
隐私声明 华为云SparkRTC SDK是由华为云计算有限公司(以下简称“我们”或“华为云”)面向华为云客户提供,方便用户接入实时音视频。华为云客户根据开发文档和用户指南,在其应用中集成SparkRTC SDK后,我们将通过被集成的SparkRTC SDK向华为云客户面向的最终用户
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
查询录制规则列表 功能介绍 调用此接口查询录制规则列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules
查询录制规则 功能介绍 调用此接口查询指定录制规则。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
音频管理 muteLocalAudio - (int)muteLocalAudio:(BOOL)mute; 【功能说明】 设置是否关闭本地音频流发送。 【请求参数】 mute:YES表示关闭音频流发送,NO表示开启音频流发送。 【返回参数】 0:方法调用成功。 > 0:方法调用失败
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后,修改后的规则对正在录制的流无效。 修改后对新的流有效,生效时间为5分钟,即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
如何对录制回调进行鉴权? 为保证录制回调通信安全,租户可以配置录制回调参数“回调秘钥”,对录制回调消息进行鉴权。本章节介绍录制回调鉴权签名的生成方法。 参数说明 表1 参数说明 参数 说明 X-Rtc-Rand 消息请求头中的随机数。 X-Rtc-Timestamp 消息请求头中的时间戳