音频采集
- HarmonyOS
更新时间不可用
adjustRecordingSignalVolume
调节音频采集信号音量。
public abstract adjustRecordingSignalVolume(volume: number): number;调用时机
加入频道前后均可调用。
调用限制
无。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
/zh-CN/api-reference/rtc/harmonyos/audio/audio-capture#api_irtcengine_enableinearmonitoring
开启耳返功能。
该方法用于打开或关闭耳返功能。
调用时机
加入频道前后均可调用。
调用限制
用户必须使用耳机(有线和蓝牙均可)才能听到耳返效果。
参数
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见错误码了解详情和解决建议。
-
- 8: 请确保当前的音频路由为蓝牙或耳机。
-
enableInEarMonitoring
开启耳返功能。
public abstract enableInEarMonitoring(enabled: boolean, includeAudioFilters?: Constants.EarMontoringFilterType): number;该方法用于打开或关闭耳返功能。
调用时机
加入频道前后均可调用。
调用限制
用户必须使用耳机(有线和蓝牙均可)才能听到耳返效果。
参数
| 参数名 | 描述 |
|---|---|
enabled | |
includeAudioFilters | 耳返 Audio filter 类型。详见 EarMontoringFilterType。 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见错误码了解详情和解决建议。
-
- 8: 请确保当前的音频路由为蓝牙或耳机。
-
所属接口类
enableLocalAudio
开启或关闭本地音频采集。
public abstract enableLocalAudio(enabled: boolean): number;当用户加入频道时,音频功能默认是开启的。该方法可以关闭或重新开启本地音频功能,即停止或重新开始本地音频采集。
该方法与 muteLocalAudioStream 的区别在于:
- enableLocalAudio: 开启或关闭本地音频采集及处理。使用 enableLocalAudio 关闭或开启本地采集后,本地听远端播放会有短暂中断。
- muteLocalAudioStream: 停止或继续发送本地音频流,不影响音频的采集状态。
适用场景
该方法不影响接收远端音频流,enableLocalAudio(false) 适用于只听不发的用户场景。
调用时机
该方法在加入频道前后均可调用。在加入频道前调用只能设置设备状态,在加入频道后才会立即生效。
调用限制
无。
相关回调
音频功能关闭或重新开启后,会收到 onLocalAudioStateChanged 回调,并报告 STOPPED(0) 或 RECORDING(1)。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
muteRecordingSignal
是否将录音信号静音。
public abstract muteRecordingSignal(muted:boolean):number;如果你已经调用 adjustRecordingSignalVolume 调节了音频采集信号音量,则调用该方法并设置为 true 时,SDK 的行为如下:
- 记录调节后的音量。
- 将音频采集信号静音。
当你再次调用该方法并设置为 false 时,录音信号会恢复为静音前 SDK 记录的音量。
调用时机
加入频道前后均可调用。
调用限制
无。
参数
true: 静音。false:(默认)原始音量。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setInEarMonitoringVolume
设置耳返音量。
public abstract setInEarMonitoringVolume(volume: number): number;调用时机
加入频道前后均可调用。
调用限制
无。
参数
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2: 参数设置无效,例如耳返音量超出取值范围 (< 0 或 > 400)。