nertc::wwiseplugin::IAudioDeviceManager类 参考

#include <IAudioDeviceManager.h>

类 nertc::wwiseplugin::IAudioDeviceManager 继承关系图:

Public 成员函数
virtual	~IAudioDeviceManager ()=default
virtual IDeviceCollection *	enumerateRecordDevices ()=0
virtual int	setRecordDevice (const char deviceId[kWWISEPLUGINMaxDeviceIDLength])=0
virtual int	getRecordDevice (char deviceId[kWWISEPLUGINMaxDeviceIDLength])=0
virtual int	setRecordDeviceVolume (uint32_t volume)=0
virtual int	getRecordDeviceVolume (uint32_t *volume)=0
virtual int	setRecordDeviceMute (bool mute)=0
virtual int	getRecordDeviceMute (bool *mute)=0
virtual int	startRecordDeviceTest (uint64_t indicationInterval)=0
virtual int	stopRecordDeviceTest ()=0
virtual int	startAudioDeviceLoopbackTest (uint64_t indicationInterval)=0
virtual int	stopAudioDeviceLoopbackTest ()=0

详细描述

音频设备管理方法。
IAudioDeviceManager 接口类提供用于管理音频设备的相关接口。

构造及析构函数说明

~IAudioDeviceManager()

virtual nertc::wwiseplugin::IAudioDeviceManager::~IAudioDeviceManager ( )

virtualdefault

成员函数说明

enumerateRecordDevices()

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

pure virtual

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

注解

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

setRecordDevice()

virtual int nertc::wwiseplugin::IAudioDeviceManager::setRecordDevice ( const char deviceId[kWWISEPLUGINMaxDeviceIDLength] )

pure virtual

指定音频采集设备。

参数

deviceId

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

getRecordDevice()

virtual int nertc::wwiseplugin::IAudioDeviceManager::getRecordDevice ( char deviceId[kWWISEPLUGINMaxDeviceIDLength] )

pure virtual

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

参数

deviceId

音频采集设备的设备 ID。

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

setRecordDeviceVolume()

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

pure virtual

设置音频采集设备音量。

参数

volume

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

getRecordDeviceVolume()

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

pure virtual

获取音频采集设备音量。

参数

volume

音频采集设备音量。

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

setRecordDeviceMute()

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

pure virtual

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

参数

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

getRecordDeviceMute()

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

pure virtual

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

参数

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

startRecordDeviceTest()

virtual int nertc::wwiseplugin::IAudioDeviceManager::startRecordDeviceTest ( uint64_t indicationInterval )

pure virtual

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

注解

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

参数

indicationInterval

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

返回

• 0: Success.
• other: Failure.

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

stopRecordDeviceTest()

virtual int nertc::wwiseplugin::IAudioDeviceManager::stopRecordDeviceTest ( )

pure virtual

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

注解

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

startAudioDeviceLoopbackTest()

virtual int nertc::wwiseplugin::IAudioDeviceManager::startAudioDeviceLoopbackTest ( uint64_t indicationInterval )

pure virtual

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

注解

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

参数

indicationInterval

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

stopAudioDeviceLoopbackTest()

virtual int nertc::wwiseplugin::IAudioDeviceManager::stopAudioDeviceLoopbackTest ( )

pure virtual

停止音频设备回路测试。

注解

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

返回

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

在 nertc::wwiseplugin::NertcAudioManagerImpl 内被实现.

---

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

• IAudioDeviceManager.h