Classes > CoreAudioDevicesMan class > Methods > CoreAudioDevices.DescGet method

Remarks

Obtains the friendly name of the audio endpoint device.

This method is only intended for usage with Windows Vista and later versions: further information about management of audio devices in Windows Vista and later versions can be found inside the How to access settings of audio devices in Windows Vista and later versions tutorial.

For further details about methods related to the management of core audio devices refer to the CoreAudioDevicesMan class.

Syntax

[Visual Basic]

Public Function DescGet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

nTypeOfName as enumCoreAudioDeviceNames

) as String

[C#]

public string DescGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

enumCoreAudioDeviceNames nTypeOfName

);

[C++]

public: string DescGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

enumCoreAudioDeviceNames nTypeOfName

);

Parameter

Description

nDataFlow

Direction in which audio data flows between an audio endpoint device and an application.

Supported values are the following:

Mnemonic Value	Value	Meaning
DEVICE_DATA_FLOW_RENDER	0	Audio rendering stream. Audio data flows from the application to the audio endpoint device, which renders the stream
DEVICE_DATA_FLOW_CAPTURE	1	Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, to the application.

nDeviceIndex

Zero-based index of the audio endpoint device. The total number of audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method.

nTypeOfName

Type of friendly name that we need to obtain.

Supported values are the following:

Mnemonic Value	Value	Meaning
DEVICE_NAME_COMPOSITE	0	The friendly name of the endpoint device, for example "Speakers (XYZ Audio Adapter)"
DEVICE_NAME_DESCRIPTION	1	The device description of the endpoint device, for example "Speakers"
DEVICE_NAME_SOUND_CARD	2	The friendly name of the audio adapter to which the endpoint device is attached, for example "XYZ Audio Adapter"

Return value

Value	Meaning

Empty string	An error occurred or information not available, check the LastError property value in order to get the error code
Valid string	The requested friendly name