音频采集
adjustRecordingSignalVolume
调节音频采集信号音量。
TypeScript
abstract adjustRecordingSignalVolume(volume: number): number;
如果你只需将音频信号静音,建议你使用 muteRecordingSignal。
调用时机
加入频道前后均可调用。
调用限制
无。
参数
- volume
- 音量,取值范围为 [0,400]。
- 0: 静音。
- 100: (默认)原始音量。
- 400: 原始音量的 4 倍,自带溢出保护。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
enableInEarMonitoring
开启耳返功能。
TypeScript
abstract enableInEarMonitoring(
enabled: boolean,
includeAudioFilters: EarMonitoringFilterType
): number;
该方法用于打开或关闭耳返功能。
调用时机
加入频道前后均可调用。
调用限制
用户必须使用耳机(有线和蓝牙均可)才能听到耳返效果。
参数
- enabled
- 开启/关闭耳返功能:
true
: 开启耳返功能。false
: (默认)关闭耳返功能。
- includeAudioFilters
- 耳返 Audio filter 类型。详见 EarMonitoringFilterType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- - 8: 请确保当前的音频路由为蓝牙或耳机。
enableLocalAudio
开启或关闭本地音频采集。
TypeScript
abstract enableLocalAudio(enabled: boolean): number;
当用户加入频道时,音频功能默认是开启的。该方法可以关闭或重新开启本地音频功能,即停止或重新开始本地音频采集。
该方法与 muteLocalAudioStream 的区别在于:
- enableLocalAudio: 开启或关闭本地音频采集及处理。使用 enableLocalAudio 关闭或开启本地采集后,本地听远端播放会有短暂中断。
- muteLocalAudioStream: 停止或继续发送本地音频流,不影响音频的采集状态。
适用场景
该方法不影响远端音频流的接收和播放。enableLocalAudio(false)
适用于只接收远端音频而不发送本地采集音频的场景。
调用时机
该方法在加入频道前后均可调用。在加入频道前调用只能设置设备状态,在加入频道后才会立即生效。
调用限制
无。
相关回调
音频功能关闭或重新开启后,会收到 onLocalAudioStateChanged 回调,并报告 LocalAudioStreamStateStopped(0) 或 LocalAudioStreamStateRecording(1)。
参数
- enabled
true
: 重新开启本地音频功能,即开启本地音频采集(默认);false
: 关闭本地音频功能,即停止本地音频采集。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
muteRecordingSignal
是否将录音信号静音。
TypeScript
abstract muteRecordingSignal(mute: boolean): number;
如果你已经调用 adjustRecordingSignalVolume 调节了音频采集信号音量,则调用该方法并设置为
true
时,SDK 的行为如下:- 记录调节后的音量。
- 将音频采集信号静音。
false
时,录音信号会恢复为静音前 SDK 记录的音量。调用时机
加入频道前后均可调用。
调用限制
无。
参数
- mute
true
: 静音。false
:(默认)原始音量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。