Classes > CoreAudioDevicesMan class > Methods > CoreAudioDevices.StatusGet method

Remarks

Obtains the status of the given audio endpoint device. The container application can be informed in real time about changes of the device status through the CallbackForCoreAudioEvents delegate having the nEvent parameter set to EV_COREAUDIO_DEVICE_STATE_CHANGED and the nData3 parameter reporting the current status.

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

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

ByRef nStatus as enumCoreAudioDeviceStates

) as enumErrorCodes

[C#]

public enumErrorCodes StatusGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

ref enumCoreAudioDeviceStates nStatus

);

[C++]

public: enumErrorCodes StatusGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

enumCoreAudioDeviceStates __gc *nStatus

);

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.

nStatus

Reference that, on return from the method call, will contain the status of the given audio endpoint device.

The returned value can be a combination of the following flags:

Mnemonic Value	Value	Meaning
DEVICE_STATE_ACTIVE	1	The device is active
DEVICE_STATE_DISABLED	2	The device is disabled
DEVICE_STATE_NOTPRESENT	4	The device is not present: the audio endpoint device is considered "not present" when the audio adapter has been installed and configured inside the system but it was physically removed at a later time: quite typical situation with devices connected through USB.
DEVICE_STATE_UNPLUGGED	8	The device is unplugged: the audio endpoint device is considered "unplugged" when the audio adapter that contains the jack for the endpoint device is present and enabled, but the endpoint device is not plugged into the jack

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.