检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
音频管理 muteRemoteAudio - (int)muteRemoteAudio:(NSString *)userId muted:(BOOL)muted; 【功能说明】 设置是否接收对应远端用户的音频流。 【请求参数】 userId:远端用户的userid,唯一标识。 m
屏幕共享 startScreenShare public abstract int startScreenShare(); 【功能说明】 开启屏幕共享。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 Android 5.0及以上版本支持此功能。 使用时,在AndroidManifest
音频管理 muteRemoteAudio public abstract int muteRemoteAudio(String userId, boolean mute); 【功能说明】 设置是否接收对应远端用户的音频流。 【请求参数】 userId:用户ID。 mute:tru
常见问题 iOS平台如何缩减安装包体积? 对于iPhone 5s及以上版本的手机支持只打包arm64架构,可以在XCode的Build Setting < Build Active Architecture Only设置为YES,并将Valid Architectures只写arm64,则SparkRTC
初始化等基础接口 createHRtcEngine huawei::rtc::IHRTCEngine* createHRtcEngine(void); 【功能说明】 创建IHRTCEngine对象。 【返回参数】 huawei::rtc::IHRTCEngine*:IHRTCEngine对象。
示例2:创建合流录制任务 场景描述 示例1:创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件,您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点:rtc-api
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
接口按功能说明 初始化等基础接口 表1 初始化等基础接口 接口 描述 windows是否支持 Mac是否支持 iOS是否支持 Android是否支持 createHRtcEngine 创建IHRTCEngine对象 √ √ √ √ getHRtcEngine 获取创建后的IHRTCEngine对象
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行(播放) 上行(上麦) 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第六次正式发布 本次变更如下: 新增以下接口: addMultiRoomMediaRelay:添加单个跨房 removeMultiRoomMediaRelay:删除单个跨房 stopMultiRoomMediaRelay:停止所有跨房
屏幕共享 startScreenShare - (int)startScreenShare; 【功能说明】 开启屏幕共享功能。 【请求参数】 无 【返回参数】 0:成功。 > 0:方法调用失败。具体请参见HWRtcErrorCode。 目前可支持多路辅流共享,若需开启多辅流,请提交工单联系技术支持处理。
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:true表示开启。false表示关闭。 【返回参数】 0:方法调用成功。 >
辅流管理 setAuxiliaryVideoEncodeSmooth public abstract int setAuxiliaryVideoEncodeSmooth(boolean enabled); 【功能说明】 设置是否开启辅流的流畅度优先。 【请求参数】 enable:
初始化等基础接口 create public static synchronized HRTCEngine create(HRTCEngineConfig config, IHRTCEngineEventHandler eventHandler) 【功能说明】 创建SparkRTC引擎实例。
常用概念 应用标识 应用标识或应用ID,简称appID,是SparkRTC用来区分不同应用的唯一标识,在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间,同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念,用于用户之间的相互隔离。
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RTC.00001001 OperationUnauthorized: get DomainID fail please check X-Auth-Token
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:YES表示开启,NO表示关闭。 【返回参数】 0:方法调用成功。 > 0:方法调用失败。