检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设置端到端加密方式。需要在加入房间前设置生效。其中sdk加密模式,需要设置16位加密密钥和加密算法,app加密模式需要先设置回调接口。 【请求参数】 encryptionParam:加密配置,具体请参见HRTCEncryptionConfig。 【返回参数】 0:成功。 <0:失败。具体请参见客户端错误码。
fy(int interval); 【功能说明】 设置音量值上报回调函数(onUserVolumeStatsNotify)的回调周期。 【请求参数】 interval:音量值上报周期,默认关闭音量回调。 0:关闭音量回调。 [100,10000]:有效值范围,单位为毫秒,建议设置为2000ms,默认值为2000ms。
获取音频播放的时长。 【请求参数】 无 【返回参数】 >0:音频时长,单位为ms。 <= 0:方法调用失败。具体请参见HRTCErrorCode。 getAudioFilePosition int getAudioFilePosition() 【功能说明】 获取音频文件当前播放位置。 【请求参数】
nable(boolean localEnable,boolean remoteEnable); 【功能说明】 设置音频数据输出使能。 【请求参数】 localEnable:true表示输出本地音频数据,false表示不输出本地音频数据。 remoteEnable:true表示输
format:(HWRtcVideoImageFormat)format; 【功能说明】 设置是否开启外部视频采集。需要在加入房间前调用。 【请求参数】 enable:YES表示开启,NO表示关闭。默认为NO。 format:设置外部采集的视频格式,默认为I420(即yuv420P)。
setExternalVideoCapture(bool enable, HRTCVideoFrameFormat format) 【功能说明】 设置是否开启外部视频采集。 【请求参数】 enable:true表示开启视频自采集,false表示取消视频自采集。默认值为false。 format:设置外部采集的视频格式,默认为I420(即yuv420P)。
常见问题 初始化引擎时,countryCode应该如何填写? countryCode表示区域码,如果对应的是GLOBAL类型,则直接填空字符串,即"",如果是CN类型,则可以填"CN"。具体请参见国家码对照表。 初始化引擎时,domain应该如何填写? 该字段已废弃,不需要再传值。 加入房间时,username必须填吗?
用量统计 用量统计 支持用户获取近90天的音视频互动时长。 云资源授权 云资源授权 支持用户对存储录制文件的OBS桶进行授权,允许SparkRTC服务将录制文件存储到OBS桶中。
路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 是 String 房间id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否
路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id room_id 是 String 房间id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否
startNetworkTest(HRTCNetworkTestConfig networkTestConfig); 【功能说明】 启动入会前网络检测。 【请求参数】 networkTestConfig:检测配置信息,具体请参见HRTCNetworkTestConfig。 【返回参数】 0:表示调用启动命令成功。
boolean remoteEnable, HRTCImageBufferFormat format); 【功能说明】 设置视频数据输出使能。 【请求参数】 localEnable:true表示输出本地视频数据,false表示不输出本地视频数据,默认值为false。 remoteEnab
muteRemoteAudio(String userId, boolean mute); 【功能说明】 设置是否接收对应远端用户的音频流。 【请求参数】 userId:用户ID。 mute:true表示取消音频流接收,false表示开启音频流接收,默认为false。 【返回参数】 0:成功。
停止播放所有音效文件。 【请求参数】 无 【返回参数】 0:方法调用成功。 < 0:方法调用失败。具体请参见客户端错误码。 pauseAllAudioClips public abstract int pauseAllAudioClips(); 【功能说明】 暂停播放所有音效文件。 【请求参数】 无
userId:必选,string[64] 类型,本端用户唯一标识。 userName:可选,string[256]类型,用户昵称,该昵称为UTF-8编码。 signature:必选,string[512]类型,鉴权签名字串,应用开发者需要向远端服务器获取鉴权签名。 远端服务器需要您自行部署,具体请参见接入鉴权。
19:对端用户无帧率 20:本端服务器下行无码流 21:本端服务器下行无帧率 abnormal_factor_desc String 异常因素描述,支持国际化 当异常类型为1时,异常因素描述与异常因素对应,取值范围为: 建链失败 房间非空闲 服务器异常 服务器反馈503 鉴权失败 鉴权重试
相同。 userId:必填,string[64]类型,用户标识,userId需要保证应用内唯一。userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线 '_'。 userName:选填,string[128]类型,用户昵称。 microphoneId跟cameraId在哪获取?为什么是必填的?
路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id rule_id 是 String 规则id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否
Rate channels:(NSUInteger)channels; 【功能说明】 设置是否开启外部音频采集。需要在加入房间前调用。 【请求参数】 enable:YES表示开启,NO表示关闭。默认为NO。 sampleRate:音频采样率,支持16k、24k、32k、44.1k、48k采样率。
rd-mode 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否 String 用户