Copyright © 2006-2026 MultiMedia Soft

CoreAudioDevices.PartsNameGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the friendly name of the given subpart for the given 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 PartsNameGet (

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

nPartIndex as Int32

) as String


 

[C#]

public string PartsNameGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

Int32 nPartIndex

);


 

[C++]

public: string PartsNameGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

Int32 nPartIndex

);


 

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 render or capture audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method passing DEVICE_DATA_FLOW_RENDER or DEVICE_DATA_FLOW_CAPTURE to the nDataFlow parameter.

nPartIndex

Zero-based index of the requested subpart. The total number of available subparts can be obtained through the CoreAudioDevices.PartsCountGet method.

 

 

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