检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务端错误码 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要APP干预或进行用户提示。该错误码由服务端产生,通过onError返回。 表1 服务端错误码 错误码 描述 错误原因 RTC.10000001 内部错误 程序或环境问题 RTC.31000000 节点不存在
查询指定项目用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。可查询5天内的数据。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id
客户端事件通知(ClientEvent) 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
常见问题 加入房间时,userName必须填吗? 非必填。userName、userId由App自定义,但可以相同。 userId:必填,string[64]类型,用户标识,userId需要保证应用内唯一。userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线
屏幕共享 功能描述 基于苹果的Replaykit方案,支持用户分享整个系统的屏幕内容,但需要App额外提供一个Extension扩展组件,可实现跨应用屏幕共享。 创建App Group 由于华为云SparkRTC是通过App Goup进行进程间的数据通信的,所以需要创建一个App
API概览 华为云实时音视频服务对应的接口列表如下所示,在调用媒体处理API前,您需要先获取用户Token,Token可以用于调用其他API时鉴权,具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
配置录制回调 SparkRTC服务提供了录制任务状态回调设置,支持配置HTTP/HTTPS URL,向用户服务器发送POST请求,将录制任务状态信息实时反馈到用户服务器。 回调协议 请求:HTTP POST请求,请求Body的内容为JSON格式。 应答:HTTP STATUS CODE
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/individual-stream-jobs
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
隐私声明 华为云SparkRTC SDK是由华为云计算有限公司(以下简称“我们”或“华为云”)面向华为云客户提供,方便用户接入实时音视频。华为云客户根据开发文档和用户指南,在其应用中集成SparkRTC SDK后,我们将通过被集成的SparkRTC SDK向华为云客户面向的最终用户
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制: 纯音频录制 encode_template填audio_only,音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填,填就忽略。