Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
agora::rtc::AudioDeviceInfo Struct Reference

`#include <NGIAgoraAudioDeviceManager.h>`

## Public Member Functions
| AudioDeviceInfo ()

## Public Attributes
char | deviceName [kAdmMaxDeviceNameSize]
char | deviceTypeName [kAdmMaxDeviceNameSize]
char | deviceId [kAdmMaxGuidSize]
bool | isCurrentSelected
bool | isPlayoutDevice

## Detailed Description

The struct of AudioDeviceInfo.

Note
  This struct applies to Windows,macOS and Linux.

## Constructor & Destructor Documentation

## ◆ AudioDeviceInfo()

agora::rtc::AudioDeviceInfo::AudioDeviceInfo | ( |  | ) |
| inline

## Member Data Documentation

## ◆ deviceName

char agora::rtc::AudioDeviceInfo::deviceName[kAdmMaxDeviceNameSize]

The name of the device. The maximum name size is 128 bytes. The default value is 0.

## ◆ deviceTypeName

char agora::rtc::AudioDeviceInfo::deviceTypeName[kAdmMaxDeviceNameSize]

The type name of the device. such as Built-in, USB, HDMI, etc. The maximum size is 128 bytes. The default value is 0.

Note
  This member applies to macOS only.

## ◆ deviceId

char agora::rtc::AudioDeviceInfo::deviceId[kAdmMaxGuidSize]

The ID of the device. The maximum size is 128 bytes. The default value is 0.

## ◆ isCurrentSelected

bool agora::rtc::AudioDeviceInfo::isCurrentSelected

Determines whether the current device is selected for audio capturing or playback.

- true: Select the current device for audio capturing or playback.
- false: (Default) Do not select the current device for audio capturing or playback.

## ◆ isPlayoutDevice

bool agora::rtc::AudioDeviceInfo::isPlayoutDevice

Determines whether the current device is the audio playout device.

- true: (Default) The current device is the playout device.
- false: The current device is not the playout device.