检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是Signature? 为保证RTC的通信安全,当用户加入频道时,华为云SparkRTC服务需要对其进行接入鉴权。 图1 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在相应的SDK的初始化或登录函数中提供“app_id”、“room_id”、“use
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ER
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix
查询录制规则 功能介绍 调用此接口查询指定录制规则。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules/{rule_id}
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
停止单流任务 功能介绍 调用此接口停止单流任务 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/individual
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
OBS桶授权及取消授权 功能介绍 OBS桶授权及取消授权。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/rtc-ops/buckets/authentication
初始化等基础接口 createHRtcEngine huawei::rtc::IHRTCEngine* createHRtcEngine(void); 【功能说明】 创建IHRTCEngine对象。 【返回参数】 huawei::rtc::IHRTCEngine*:IHRTCEngine对象。
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后,修改后的规则对正在录制的流无效。 修改后对新的流有效,生效时间为5分钟,即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API E
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/ap
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则,则会创建新的录制规则 若当前app在请求的location中已有录制规则,则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
HRTCDeviceState deviceState) 【功能说明】 设备状态发生变化,触发此回调。 【回调参数】 deviceId:系统设备标识,如系统音频播放设备标识可通过getPlaybackDevices获取。 deviceType:系统设备类型,具体请参见HRTCDeviceType。
事件回调(HWRtcConnection) 本章节介绍了iOS/macOS SDK的回调接口HWRtcConnectionDelegate的详情。 表1 事件回调说明 接口 描述 connection:onJoinSuccess 成功加入跨房房间回调 connection:onJoinRoomFailure
HRTCDeviceState deviceState) 【功能说明】 设备状态发生变化,触发此回调。 【回调参数】 deviceId:系统设备标识,如系统音频播放设备标识可通过getPlaybackDevices获取。 deviceType:系统设备类型,具体请参见HRTCDeviceType。
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:YES表示开启,NO表示关闭。 【返回参数】 0:方法调用成功。 > 0:方法调用失败。
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:true表示开启。false表示关闭。 【返回参数】 0:方法调用成功。 >
事件回调(IHRTCConnectionEventHandler) 本章节介绍了Android SDK的回调接口IHRTCConnectionEventHandler的详情。 表1 回调接口 接口 描述 onError 错误回调 onJoinRoomSuccess 加入房间成功回调