Copyright © 2005-2018 MultiMedia Soft

CoreAudioDevices.DefaultGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the system default device for the given role. The container application can be notified about changes to the system default device by catching the CoreAudioDeviceDefaultChange event.

 

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

nDataFlow as enumCoreAudioDataFlows,

nRole as enumCoreAudioRoles,

ByRef nDeviceIndex as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes DefaultGet (

enumCoreAudioDataFlows nDataFlow,

enumCoreAudioRoles nRole,

ref Int16 nDeviceIndex

);


 

[C++]

public: enumErrorCodes DefaultGet (

enumCoreAudioDataFlows nDataFlow,

enumCoreAudioRoles nRole,

Int16 __gc *nDeviceIndex

);


 

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.

nRole

The role that the system has assigned to an audio endpoint device.

Supported values are the following:

Mnemonic Value

Value

Meaning

DEVICE_ROLE_CONSOLE

0

Games, system notification sounds, and voice commands

DEVICE_ROLE_MULTIMEDIA

1

Music, movies, narration, and live music recording

DEVICE_ROLE_COMMUNICATIONS

2

Voice communications

nDeviceIndex

Reference that, on return from the method call, will contain the zero-based index of the default audio endpoint device for the given type of data flow and role.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.