rtc
音频基础功能
更新时间:2021/01/07 GMT+08:00
muteLocalAudioStream
muteLocalAudioStream(mute: boolean): number
【功能说明】
停止/恢复发送本地音频流。
【请求参数】
mute:必选,boolean类型,true表示停止,false表示恢复。
【返回参数】
number类型,0表示调用成功,其他表示调用失败。
muteRemoteAudioStream
muteRemoteAudioStream(userId: string, mute: boolean): number
【功能说明】
停止/恢复接收指定的远端音频流。
【请求参数】
- userId:必选,string类型,用户ID。
- mute:必选,boolean类型,true表示停止,false表示恢复。
【返回参数】
number类型,0表示调用成功,其它值表示调用失败。
muteAllRemoteAudioStreams
muteAllRemoteAudioStreams(mute: boolean): number
【功能说明】
停止/恢复接收全部远端音频流。
【请求参数】
mute:必选,boolean类型,true表示停止,false表示恢复设置的topN的音频流。
【返回参数】
number类型,0表示调用成功,其它值表示调用失败。
setRemoteAudioTopNVoice
setRemoteAudioTopNVoice(topN:number): number
【功能说明】
设置接收音量最大的N方的音频流。
【请求参数】
topN:必选,number类型。默认值为3,最大值为17,即当前房间最大容纳的非player用户数。
【返回参数】
number类型,0表示调用成功,其它值表示调用失败。
enableLocalAudio
enableLocalAudio(enable: boolean): number
【功能说明】
开启/关闭本地音频采集。
【请求参数】
enable:必选,boolean类型。true表示开启,false表示关闭。
【返回参数】
number类型,0表示调用成功,其它值表示调用失败。
enableUserVolumeNotify
enableUserVolumeNotify(interval:number):number
【功能说明】
设置远端用户音量上报周期。
【请求参数】
interval:必选,number类型。音量值上报周期,默认关闭音量回调,单位毫秒。
- 0:关闭音量回调。
- [100,10000]:有效值范围,单位:毫秒。
【返回参数】
number类型,0表示调用成功,其它值表示调用失败。
【注意事项】
调用该函数后,每隔一段时间(interval)的时间,会收到userVolumeStats回调事件,包含这段时间内说话的用户信息和音量信息。
父主题: HRTCEngine
