Agora RTC Objective-C API Reference  Refactor
Data Fields
AudioDeviceInfo Struct Reference

Data Fields

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.

Constructor & Destructor Documentation

◆ AudioDeviceInfo() [1/2]

AudioDeviceInfo ( )
inline

◆ AudioDeviceInfo() [2/2]

AudioDeviceInfo ( const AudioDeviceInfo other)
inline

Member Function Documentation

◆ operator=()

AudioDeviceInfo& operator= ( const AudioDeviceInfo other)
inline

Field Documentation

◆ deviceName

char deviceName[kAdmMaxDeviceNameSize]

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

◆ deviceId

char deviceId[kAdmMaxGuidSize]

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

◆ isCurrentSelected

bool 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 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 routing

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