Copyright © 2006-2018 MultiMedia Soft

CoreAudioDevices.Enum method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enumerates audio endpoint devices installed inside the system.

 

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

nStateMask as enumCoreAudioDeviceStates

) as enumErrorCodes


 

[C#]

public enumErrorCodes Enum (

enumCoreAudioDeviceStates nStateMask

);


 

[C++]

public: enumErrorCodes Enum (

enumCoreAudioDeviceStates nStateMask

);


 

Parameter

Description

 

 

nStateMask

The states of the devices that are to be included in the collection.

This value can be a combination of the following flags:

Mnemonic Value

Value

Meaning

DEVICE_STATE_ACTIVE

1

Include active audio endpoint devices

DEVICE_STATE_DISABLED

2

Include disabled audio endpoint devices

DEVICE_STATE_NOTPRESENT

4

Include not present audio endpoint devices: the audio endpoint device is considered "not present" when the audio adapter has been installed and configured inside the system but it was phisically removed at a later time: quite typical situation with devices connected through USB.

DEVICE_STATE_UNPLUGGED

8

Include unplugged audio endpoint devices: 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.