#include <INertcAudioDeviceManager.h>

Public 成员函数
virtual	~IAudioDeviceManager ()

virtual IDeviceCollection *	enumerateRecordDevices ()=0

virtual int	setRecordDevice (const char device_id[kNERtcMaxDeviceIDLength])=0

virtual int	getRecordDevice (char device_id[kNERtcMaxDeviceIDLength])=0

virtual IDeviceCollection *	enumeratePlayoutDevices ()=0

virtual int	setPlayoutDevice (const char device_id[kNERtcMaxDeviceIDLength])=0

virtual int	getPlayoutDevice (char device_id[kNERtcMaxDeviceIDLength])=0

virtual int	setRecordDeviceVolume (uint32_t volume)=0

virtual int	getRecordDeviceVolume (uint32_t *volume)=0

virtual int	setPlayoutDeviceVolume (uint32_t volume)=0

virtual int	getPlayoutDeviceVolume (uint32_t *volume)=0

virtual int	setPlayoutDeviceMute (bool mute)=0

virtual int	getPlayoutDeviceMute (bool *mute)=0

virtual int	setRecordDeviceMute (bool mute)=0

virtual int	getRecordDeviceMute (bool *mute)=0

virtual int	startRecordDeviceTest (uint64_t indication_interval)=0

virtual int	stopRecordDeviceTest ()=0

virtual int	startPlayoutDeviceTest (const char *test_audio_file_path)=0

virtual int	stopPlayoutDeviceTest ()=0

virtual int	startAudioDeviceLoopbackTest (uint64_t indication_interval)=0

virtual int	stopAudioDeviceLoopbackTest ()=0

构造及析构函数说明

◆ ~IAudioDeviceManager()

virtual nertc::IAudioDeviceManager::~IAudioDeviceManager ( )

inlinevirtual

成员函数说明

◆ enumeratePlayoutDevices()

virtual IDeviceCollection * nertc::IAudioDeviceManager::enumeratePlayoutDevices ( )

pure virtual

获取系统中所有的播放设备列表。
该方法返回一个 IDeviceCollection 对象，包含系统中所有的播放设备。通过 IDeviceCollection 对象，App 可以枚举播放设备。在使用结束后，App 需调用 destroy 方法销毁返回的对象。

注解: 程序必须调用 destroy 方法销毁返回的值。

返回

方法调用成功：一个 IDeviceCollection 对象，包含所有的音频播放设备。
方法调用失败：NULL。

◆ enumerateRecordDevices()

virtual IDeviceCollection * nertc::IAudioDeviceManager::enumerateRecordDevices ( )

pure virtual

获取系统中所有的音频采集设备列表。
该方法返回一个 IDeviceCollection 对象，包含系统中所有的音频采集设备。通过IDeviceCollection 对象，App 可以枚举音频采集设备。

注解: 在使用结束后，App 需调用 destroy 方法销毁返回的对象。

返回

方法调用成功：一个 IDeviceCollection 对象，包含所有的音频采集设备。
方法调用失败：NULL。

◆ getPlayoutDevice()

virtual int nertc::IAudioDeviceManager::getPlayoutDevice ( char device_id[kNERtcMaxDeviceIDLength] )

pure virtual

获取当前使用的音频播放设备 ID。

参数

device_id 音频播放设备的设备 ID。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ getPlayoutDeviceMute()

virtual int nertc::IAudioDeviceManager::getPlayoutDeviceMute ( bool * mute )

pure virtual

获取音频播放设备静音状态。

参数

mute	音频播放设备静音状态。 true：静音状态。 false：非静音状态。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ getPlayoutDeviceVolume()

virtual int nertc::IAudioDeviceManager::getPlayoutDeviceVolume ( uint32_t * volume )

pure virtual

获取音频播放设备音量。

参数

volume 音频播放设备音量。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ getRecordDevice()

virtual int nertc::IAudioDeviceManager::getRecordDevice ( char device_id[kNERtcMaxDeviceIDLength] )

pure virtual

获取当前使用的音频采集设备 ID。

参数

device_id 音频采集设备的设备 ID。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ getRecordDeviceMute()

virtual int nertc::IAudioDeviceManager::getRecordDeviceMute ( bool * mute )

pure virtual

获取音频采集设备静音状态。

参数

mute	音频采集设备静音状态。 true: 静音状态。 false: 非静音状态。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ getRecordDeviceVolume()

virtual int nertc::IAudioDeviceManager::getRecordDeviceVolume ( uint32_t * volume )

pure virtual

获取音频采集设备音量。

参数

volume 音频采集设备音量。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setPlayoutDevice()

virtual int nertc::IAudioDeviceManager::setPlayoutDevice ( const char device_id[kNERtcMaxDeviceIDLength] )

pure virtual

指定播放设备。

参数

device_id 音频播放设备的设备 ID。可以通过 enumeratePlayoutDevices 获取。插拔设备不会影响 deviceId。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setPlayoutDeviceMute()

virtual int nertc::IAudioDeviceManager::setPlayoutDeviceMute ( bool mute )

pure virtual

静音或取消静音音频播放设备。

参数

mute	是否静音音频播放设备。 true：静音音频播放设备。 false：取消静音音频播放设备。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setPlayoutDeviceVolume()

virtual int nertc::IAudioDeviceManager::setPlayoutDeviceVolume ( uint32_t volume )

pure virtual

设置音频播放设备音量。

参数

volume 音频播放设备音量。取值范围为 0~255。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setRecordDevice()

virtual int nertc::IAudioDeviceManager::setRecordDevice ( const char device_id[kNERtcMaxDeviceIDLength] )

pure virtual

指定音频采集设备。

参数

device_id 音频采集设备的设备 ID。可通过 enumerateRecordDevices 获取。插拔设备不会影响 deviceId。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setRecordDeviceMute()

virtual int nertc::IAudioDeviceManager::setRecordDeviceMute ( bool mute )

pure virtual

静音或取消静音音频采集设备。

参数

mute	是否静音音频采集设备。 true：静音音频采集设备。 false：取消静音音频采集设备。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ setRecordDeviceVolume()

virtual int nertc::IAudioDeviceManager::setRecordDeviceVolume ( uint32_t volume )

pure virtual

设置音频采集设备音量。

参数

volume 音频采集设备音量。取值范围为 0~255。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ startAudioDeviceLoopbackTest()

virtual int nertc::IAudioDeviceManager::startAudioDeviceLoopbackTest ( uint64_t indication_interval )

pure virtual

开始音频设备回路测试。
该方法测试音频采集和播放设备是否能正常工作。一旦测试开始，音频采集设备会采集本地音频，然后使用音频播放设备播放出来。 SDK 会按设置的时间间隔触发 onLocalAudioVolumeIndication 回调，报告音量信息。

注解

该方法需在加入房间前调用。
音频设备回路测试会在通话开始后自动结束，您也可以手动调用 stopAudioDeviceLoopbackTest 停止音频设备回路测试。
该方法仅在本地进行音频设备测试，不涉及网络连接。

参数

indication_interval SDK 返回 onLocalAudioVolumeIndication 回调的时间间隔，单位为毫秒。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ startPlayoutDeviceTest()

virtual int nertc::IAudioDeviceManager::startPlayoutDeviceTest ( const char * test_audio_file_path )

pure virtual

启动音频播放设备测试。该方法测试音频播放设备是否能正常工作。启动测试后，SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。调用该方法后，SDK 会每隔 100 ms 触发一次 onLocalAudioVolumeIndication 回调，报告播放设备的音量信息。

注解

该方法需在加入房间前调用。
音频播放设备测试会在通话开始后自动结束，您也可以手动调用 stopPlayoutDeviceTest 停止音频播放设备测试。
支持文件格式包括 wav、mp3、aac。

参数

test_audio_file_path 音频文件的绝对路径，路径字符串使用 UTF-8 编码格式。

返回

0: 成功，并且可以听到所设置文件的声音。
其他：失败。

◆ startRecordDeviceTest()

virtual int nertc::IAudioDeviceManager::startRecordDeviceTest ( uint64_t indication_interval )

pure virtual

启动音频采集设备测试。
该方法测试音频采集设备是否能正常工作。
调用该方法后，SDK 会按设置的时间间隔触发 onLocalAudioVolumeIndication 回调，报告采集设备的音量信息。

注解

该方法需在加入房间前调用。
音频采集设备测试会在通话开始后自动结束，您也可以手动调用 stopRecordDeviceTest 停止音频采集设备测试。

参数

indication_interval SDK 返回 onLocalAudioVolumeIndication 回调的时间间隔，单位为毫秒。

返回

0: Success.
other: Failure.

◆ stopAudioDeviceLoopbackTest()

virtual int nertc::IAudioDeviceManager::stopAudioDeviceLoopbackTest ( )

pure virtual

停止音频设备回路测试。

注解

该方法需在加入房间前调用。
音频设备回路测试会在通话开始后自动结束，您也可以手动调用 stopAudioDeviceLoopbackTest 停止音频设备回路测试。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ stopPlayoutDeviceTest()

virtual int nertc::IAudioDeviceManager::stopPlayoutDeviceTest ( )

pure virtual

停止播放设备测试。

注解

该方法需在加入房间前调用。
播放设备测试会在通话开始后自动结束，您也可以手动调用 stopPlayoutDeviceTest 停止播放设备测试。

返回

0: 方法调用成功；
其他: 方法调用失败。

◆ stopRecordDeviceTest()

virtual int nertc::IAudioDeviceManager::stopRecordDeviceTest ( )

pure virtual

停止音频采集设备测试。
该方法停止音频采集设备测试。

注解

该方法需在加入房间前调用。
音频采集设备测试会在通话开始后自动结束，您也可以手动调用 stopRecordDeviceTest 停止音频采集设备测试。

返回

0: 方法调用成功；
其他: 方法调用失败。

该类的文档由以下文件生成:

D:/Formatter/api-for-code/1-ToWarehouse/unreal-sdk/Plugins/NertcPlugin/Source/NertcPlugin/Public/INertcAudioDeviceManager.h

Public 成员函数

构造及析构函数说明

◆ ~IAudioDeviceManager()

成员函数说明

◆ enumeratePlayoutDevices()

◆ enumerateRecordDevices()

◆ getPlayoutDevice()

◆ getPlayoutDeviceMute()

◆ getPlayoutDeviceVolume()

◆ getRecordDevice()

◆ getRecordDeviceMute()

◆ getRecordDeviceVolume()

◆ setPlayoutDevice()

◆ setPlayoutDeviceMute()

◆ setPlayoutDeviceVolume()

◆ setRecordDevice()

◆ setRecordDeviceMute()

◆ setRecordDeviceVolume()

◆ startAudioDeviceLoopbackTest()

◆ startPlayoutDeviceTest()

◆ startRecordDeviceTest()

◆ stopAudioDeviceLoopbackTest()

◆ stopPlayoutDeviceTest()

◆ stopRecordDeviceTest()