检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
用时序图展示各端接口使用顺序,单击相应接口可以快速查看相关接口使用方法。 技巧2:接口总览说明 包括SparkRTC接口总体功能流程图和接口列表,根据功能分类可以快速查找具体功能单个接口,方便接口对接。 技巧3:单个接口使用须知 接口使用时注意使用的时机、参数说明。“注意”是强调每个
a为大版本号:在版本架构重构的情况下更新。 b为小版本号:在重大特性或接口变更的情况下更新。 c为月度开发版本号:月度累加。 d为release版本号:300开头表示第一个release版本号,补丁版本累加。 版本号样例:2.0.9.300 版本周期 默认2-3个月发布一个大版本,或根据客户的诉求进行发布变更。
"userName"; joinRoomParam.authorization = authorization;//authorization:鉴权信息,具体生成方法请参见接入鉴权。与加入房间的authorization相同 joinRoomParam.ctime = time;//与加入房间的time相同
"userName"; joinRoomParam.authorization = authorization; //authorization:鉴权信息,具体生成方法请参见接入鉴权。与加入房间的authorization相同 joinRoomParam.ctime = time;//与加入房间的time相同
"userName"; joinRoomParam.authorization = authorization; //authorization:鉴权信息,具体生成方法请参见接入鉴权。与加入房间的authorization相同 joinRoomParam.ctime = time;//与加入房间的time相同
值为'm'代表合流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/mix-stream-jobs 表1 路径参数
可选,string[2]类型,需要满足ISO 3166-1的2位字母的国家码要求。表示业务接入点的国家码,SDK会根据设置将业务接入到对应区域的服务,如:CN表示中国大陆,US表示美国,HK表示中国香港。countryCode值的填写具体请参见国家码对照表。该参数为2.0.3版本新增,且为必选参数,从2.0.7版本开始,修改为可选参数。
boolean类型,true表示禁用音频轨道成功,false表示禁用音频轨道失败。 muteVideo muteVideo(): boolean 【功能说明】 禁用视频轨道。 【请求参数】 无 【返回参数】 boolean类型,true表示禁用视频轨道成功,false表示禁用视频轨道失败。
加入房间前设置音频最大三方模式 入会前调用enableTopThreeAudioMode设置是否开启音频最大三方模式。true表示开启音频最大三方,false表示不开启。 示例代码如下: this.client.enableTopThreeAudioMode(true) 加入房间 参考接口调用流程中加入房间的时序图步骤。
设置显示模式,区分横屏和竖屏,用于保证摄像头方向与本地界面方向一致。 【请求参数】 layoutDirect:0表示横屏模式,1表示竖屏模式,2表示横屏重力感应,3表示重力感应,4表示竖屏模式且不会随设备旋转改变采集角度,5表示adaptive模式,适用非dns模式推流外的大部分场景,能自动适配app的布局,自动调整采集方向。
OBS桶管理 查询OBS桶列表 查询OBS桶下对象列表 OBS桶授权及取消授权
修订记录 表1 表1 修订记录 发布日期 修订说明 2023-11-30 实时音视频所有客户端类型均增加“环境准备”章节。 2022-09-30 更新“单流录制”和“合流录制”章节的操作内容。 2021-10-30 第一次正式发布。
pushLocalVideo(boolean push); 【功能说明】 设置是否发送本地视频流。 【请求参数】 push:true表示发送,false表示不发送。 【返回参数】 0:成功。 >0:失败。具体请参见客户端错误码。 setVideoEncoderConfig public
参考接口调用流程中加入房间的时序图步骤加入房间。 共享桌面 加入房间后可以调用getScreenShareSources获取屏幕共享对象列表,然后遍历找到其中HRTCScreenShareSourceInfo.type为HWRtcScreenShareTypeDesktop的对象
reSourceInfo *> *)getScreenShareSources; 【功能说明】 获取资源共享列表。 【请求参数】 无 【返回参数】 当前可共享的资源列表。具体请参见HWRtcScreenShareSourceInfo。 只支持macOS。 setScreenShareTarget
媒体原始数据管理 表1 connection媒体原始数据管理 接口 描述 setVideoFrameObserver 注册原始视频媒体数据监听回调 setVideoFrameObserver - (int)setVideoFrameObserver:(id <HWRtcConne
附录 Grs国家/地区码对照表
【功能说明】 开启、关闭指定远端用户的视频流。 【请求参数】 userId:远端用户的userId,唯一标识。 pull:true表示开始接收,false表示关闭接收。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 setupRemoteView public abstract
ished。 新增客户端错误码。 优化部分文档描述。 2021-12-02 第八次正式发布 本次变更如下: 增加常见问题列表及处理手段。 增加浏览器支持的列表及使用限制。 优化部分文档描述。 2021-11-22 第七次正式发布 本次变更如下: 支持Firefox、Safari 11/12等浏览器适配。
应用管理 创建应用 查询应用列表 查询单个应用 删除应用 启用应用 停用应用