音频采集
AdjustLoopbackSignalVolume
调节声卡采集信号音量。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int AdjustLoopbackSignalVolume(int volume);
详情
调用 EnableLoopbackRecording 开启声卡采集后,你可以调用该方法调节声卡采集的信号音量。
参数
- volume
- 音乐文件音量范围为 0~100。100 (默认值)为原始文件音量。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
AdjustRecordingSignalVolume
调节音频采集信号音量。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int AdjustRecordingSignalVolume(int volume);
详情
注意
该方法在加入频道前后都能调用。
参数
- volume
- 音量,取值范围为 [0,400]。
- 0: 静音。信息如果你只需将音频信号静音,声网建议你使用 MuteRecordingSignal。
- 100: (默认)原始音量。
- 400: 原始音量的 4 倍,自带溢出保护。
- 0: 静音。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
EnableInEarMonitoring
开启耳返功能。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int EnableInEarMonitoring(bool enabled, int includeAudioFilters);
详情
该方法打开或关闭耳返功能。
注意
- 用户必须使用耳机(有线和蓝牙均可)才能听到耳返效果。
- 该方法在加入频道前后都能调用。
参数
- enabled
- 开启/关闭耳返功能:
true
: 开启耳返功能。false
: (默认)关闭耳返功能。
- includeAudioFilters
- 耳返 audio filter 类型:
- EAR_MONITORING_FILTER_NONE (1 << 0):不在耳返中添加 audio filter。
- EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS (1 << 1): 在耳返中添加人声效果 audio filter。如果你实现了美声、音效等功能,用户可以在耳返中听到添加效果后的声音。
- EAR_MONITORING_FILTER_NOISE_SUPPRESSION (1 <<2):在耳返中添加降噪 audio filter。 可使用按位或运算符 (|) 添加多个 audio filter。注意如果你将 enabled 参数设为
false
,则无需设置 includeAudioFilters 参数。
返回值
- >0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- - 8: 请确保当前的音频路由为蓝牙或耳机。
EnableLocalAudio
开关本地音频采集。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int EnableLocalAudio(bool enabled);
详情
当用户加入频道时,音频功能默认是开启的。该方法可以关闭或重新开启本地音频功能,即停止或重新开始本地音频采集。
该方法不影响接收远端音频流,EnableLocalAudio(false)
适用于只听不发的用户场景。
音频功能关闭或重新开启后,会收到 FOnLocalAudioStateChanged 回调,并报告 LOCAL_AUDIO_STREAM_STATE_STOPPED(0) 或 LOCAL_AUDIO_STREAM_STATE_RECORDING(1)。
注意
- 该方法与 MuteLocalAudioStream 的区别在于:
- EnableLocalAudio: 开启或关闭本地音频采集及处理。使用 EnableLocalAudio 关闭或开启本地采集后,本地听远端播放会有短暂中断。
- MuteLocalAudioStream: 停止或继续发送本地音频流。
- 该方法在加入频道前后均可调用。在加入频道前调用只能设置设备状态,在加入频道后才会立即生效。
参数
- enabled
true
: 重新开启本地音频功能,即开启本地音频采集(默认);false
: 关闭本地音频功能,即停止本地音频采集。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
EnableLoopbackRecording
开启声卡采集。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int EnableLoopbackRecording(bool enabled, FString deviceName);
详情
启用声卡采集功能后,声卡播放的声音会被合到本地音频流中,从而可以发送到远端。
注意
- 该方法仅适用于 macOS 和 Windows 平台。
- macOS 系统默认声卡不支持采集功能,如果你需要使用该功能,请启用一个虚拟声卡,并将 deviceName 设为该虚拟声卡的设备名。声网推荐你使用声网自研的虚拟声卡 AgoraALD 进行采集。
- 该方法在加入频道前后都能调用。
参数
- enabled
- 是否开启声卡采集:
true
: 开启声卡采集。false
:(默认)关闭声卡采集。
- deviceName
- macOS: 虚拟声卡的设备名。默认为空,代表使用 AgoraALD 虚拟声卡进行采集。
- Windows: 声卡的设备名。默认为空,代表使用设备自带的声卡进行采集。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
EnableLoopbackRecordingEx
开启声卡采集。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int EnableLoopbackRecordingEx(const FRtcConnection& connection, bool enabled, FString deviceName);
详情
启用声卡采集功能后,声卡播放的声音会被合到本地音频流中,从而可以发送到远端。
注意
- 该方法仅适用于 macOS 和 Windows 平台。
- macOS 系统默认声卡不支持采集功能,如果你需要使用该功能,请启用一个虚拟声卡,并将 deviceName 设为该虚拟声卡的设备名。声网推荐你使用声网自研的虚拟声卡 AgoraALD 进行采集。
- 该方法目前仅支持一路声卡采集。
参数
- connection
- Connection 信息。详见 FRtcConnection。
- enabled
- 是否开启声卡采集:
true
: 开启声卡采集。false
:(默认)不开启声卡采集。
- deviceName
- macOS: 虚拟声卡的设备名。默认为空,代表使用 AgoraALD 虚拟声卡进行采集。
- Windows: 声卡的设备名。默认为空,代表使用设备自带的声卡进行采集。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
MuteRecordingSignal
是否将录音信号静音。
C++
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int MuteRecordingSignal(bool mute);
参数
- mute
true
: 静音。false
:(默认)原始音量。
信息如果你已经调用 AdjustRecordingSignalVolume 调节了音量,则调用该方法并设置为true
时,SDK 会记录当前音量并将其静音。如需恢复之前的音量,再次调用该方法并设置为false
即可。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。