文档中心
互动直播 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

C++ API Reference for All Platforms

概览 IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

#include <IAgoraRtcEngine.h>

Public 成员函数

virtual int getCount ()=0
 
virtual int getDevice (int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH])=0
 
virtual int setDevice (const char deviceId[MAX_DEVICE_ID_LENGTH])=0
 
virtual int getDefaultDevice (char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH])=0
 
virtual int setApplicationVolume (int volume)=0
 
virtual int getApplicationVolume (int &volume)=0
 
virtual int setApplicationMute (bool mute)=0
 
virtual int isApplicationMute (bool &mute)=0
 
virtual void release ()=0
 

Protected 成员函数

virtual ~IAudioDeviceCollection ()
 

详细描述

音频设备信息收集方法。

IAudioDeviceCollection 接口类获取音频设备相关的数据。

构造及析构函数说明

◆ ~IAudioDeviceCollection()

virtual agora::rtc::IAudioDeviceCollection::~IAudioDeviceCollection ( )
inlineprotectedvirtual

成员函数说明

◆ getCount()

virtual int agora::rtc::IAudioDeviceCollection::getCount ( )
pure virtual

获取播放或音频采集设备数量。（仅适用于 macOS 和 Windows）

如果先调用 enumeratePlaybackDevices 再调用该方法，返回播放设备的数量。如果先调用 enumerateRecordingDevices 再调用该方法，返回音频采集设备的数量。

返回
语音设备数目。

◆ getDevice()

virtual int agora::rtc::IAudioDeviceCollection::getDevice ( int  index,
char  deviceName[MAX_DEVICE_ID_LENGTH],
char  deviceId[MAX_DEVICE_ID_LENGTH] 
)
pure virtual

获取指定index的设备信息。（仅适用于 macOS 和 Windows）

参数
index输入参数，指定想查询的设备信息。
deviceName输出参数，设备名称。
deviceId输出参数，设备 ID。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setDevice()

virtual int agora::rtc::IAudioDeviceCollection::setDevice ( const char  deviceId[MAX_DEVICE_ID_LENGTH])
pure virtual

指定设备。（仅适用于 macOS 和 Windows）

参数
deviceId设备 ID。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getDefaultDevice()

virtual int agora::rtc::IAudioDeviceCollection::getDefaultDevice ( char  deviceName[MAX_DEVICE_ID_LENGTH],
char  deviceId[MAX_DEVICE_ID_LENGTH] 
)
pure virtual

获取系统默认的音频设备。（仅适用于 macOS 和 Windows）

自从
v3.6.0
参数
deviceName系统默认的音频设备名称。
deviceId系统默认的音频设备 ID。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setApplicationVolume()

virtual int agora::rtc::IAudioDeviceCollection::setApplicationVolume ( int  volume)
pure virtual

设置 App 音量。（仅适用于 macOS 和 Windows）

参数
volume音量值，范围 [0,255]。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getApplicationVolume()

virtual int agora::rtc::IAudioDeviceCollection::getApplicationVolume ( int &  volume)
pure virtual

获取 App 的当前音量。（仅适用于 macOS 和 Windows）

参数
volume音量值，范围 [0,255]。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setApplicationMute()

virtual int agora::rtc::IAudioDeviceCollection::setApplicationMute ( bool  mute)
pure virtual

设置 App 静音。（仅适用于 macOS 和 Windows）

参数
mute
  • true: App 设为静音；
  • false: App 设为不静音。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ isApplicationMute()

virtual int agora::rtc::IAudioDeviceCollection::isApplicationMute ( bool &  mute)
pure virtual

获取 App 当前的静音状态。（仅适用于 macOS 和 Windows）

参数
mute
  • true: App 为静音状态；
  • false: App 为非静音状态。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ release()

virtual void agora::rtc::IAudioDeviceCollection::release ( )
pure virtual

释放 IAudioDeviceCollection 对象占用的所有资源。（仅适用于 macOS 和 Windows）