Copyright © 2005-2018 MultiMedia Soft

CoreAudioDevices.ChannelCountGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

After having enumerated the list of available audio endpoint devices through the CoreAudioDevices.Enum method, obtains the number of channels for a specific audio endpoint device having a specific data flow (playback or recording).

 

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

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

ByRef nChannelsCount as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes ChannelCountGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

ref Int16 nChannelsCount

);


 

[C++]

public: enumErrorCodes ChannelCountGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

Int16 __gc *nChannelsCount

);


 

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.

nChannelsCount

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

 

 

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.