Classes > CoreAudioDevicesMan class > Methods > CoreAudioDevices.JackDescriptorGet method

Remarks

Obtains the description of an audio jack on the connector.

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 JackDescriptorGet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

nJackIndex as Integer,

ByRef desc as KSJACK_DESCRIPTION

) as enumErrorCodes

[C#]

public enumErrorCodes JackDescriptorGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

Int16 nJackIndex,

ref KSJACK_DESCRIPTION desc

);

[C++]

public: enumErrorCodes JackDescriptorGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

Int16 nJackIndex,

KSJACK_DESCRIPTION __gc *desc

);

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.

nJackIndex

Zero-based index of the jack. The total number of jacks for an audio endpoint device can be obtained through the CoreAudioDevices.JackCountGet method.

desc

Reference to a structure of type KSJACK_DESCRIPTION that, on return from the method call, will contain the descriptor of the jack; you can refer to the MSDN (Microsoft Developers Network) website for further information about this structure.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.