agora::rtc::AudioDeviceInfo Struct Reference

#include <AgoraMediaBase.h>

Public Member Functions
	AudioDeviceInfo (const AudioDeviceInfo &other)
AudioDeviceInfo &	operator= (const AudioDeviceInfo &other)

Public Attributes
char	deviceName [kAdmMaxDeviceNameSize]
char	deviceId [kAdmMaxGuidSize]
bool	isCurrentSelected
bool	isPlayoutDevice
AudioRoute	routing

Detailed Description

The struct of AudioDeviceInfo.

Note

This struct applies to Windows and macOS only.

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.

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.

routing

AudioRoute agora::rtc::AudioDeviceInfo::routing

The routing of the device. The default value is ROUTE_DEFAULT.