Classes > CoreAudioDevicesMan class > Methods > CoreAudioDevices.CapturePartChannelVolumeGet method

Remarks

Obtains the channel's level of a part embedded inside the given capture audio endpoint device. The current level for the same part can be modified through the CoreAudioDevices.CapturePartChannelVolumeSet method.

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

nDeviceIndex as Int16,

nPartId as enumCoreAudioCaptureParts,

nChannel as Int16,

ByRef fLevelIndB as Single,

ByRef fRangeMinIndB as Single,

ByRef fRangeMaxIndB as Single,

ByRef fSteppingIndB as Single

) as enumErrorCodes

[C#]

public enumErrorCodes CapturePartChannelVolumeGet (

Int16 nDeviceIndex,

enumCoreAudioCaptureParts nPartId,

Int16 nChannel,

ref float fLevelIndB,

ref float fRangeMinIndB,

ref float fRangeMaxIndB,

ref float fSteppingIndB

);

[C++]

public: enumErrorCodes CapturePartChannelVolumeGet (

Int16 nDeviceIndex,

enumCoreAudioCaptureParts nPartId,

Int16 nChannel,

float __gc *fLevelIndB,

float __gc *fRangeMinIndB,

float __gc *fRangeMaxIndB,

float __gc *fSteppingIndB

);

Parameter

Description

nDeviceIndex

Zero-based index of the capture audio endpoint device. The total number of capture audio endpoint devices can be obtained through the CoreAudioDevices.CountGet method passing DEVICE_DATA_FLOW_CAPTURE to the nDataFlow parameter.

nPartId

Identifier of the capture part.

Supported values are the following:

Mnemonic Value	Value	Meaning
CAPTURE_PART_MIC_BOOST	0	Microphone boost.

nChannel

Zero-based index of the channel. The total number of channels can be obtained through the CoreAudioDevices.CapturePartChannelCountGet method.

fLevelIndB

Reference that, on return from the method call, will contain the volume level expressed in dB

fRangeMinIndB

Reference that, on return from the method call, will contain the minimum supported level in dB.

fRangeMaxIndB

Reference that, on return from the method call, will contain the maximum supported level in dB.

fSteppingIndB

Reference that, on return from the method call, will contain the stepping value between consecutive levels in the range fRangeMinIndB to fRangeMaxIndB.

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.