Copyright © 2005-2018 MultiMedia Soft

CoreAudioDevices.CapturePartChannelVolumeSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the channel's level of a part embedded inside the given capture audio endpoint device. The current level can be obtained through the CoreAudioDevices.CapturePartChannelVolumeGet 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 CapturePartChannelVolumeSet (

nDeviceIndex as Int16,

nPartId as enumCoreAudioCaptureParts,

nChannel as Int16,

fLevelIndB as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes CapturePartChannelVolumeSet (

Int16 nDeviceIndex,

enumCoreAudioCaptureParts nPartId,

Int16 nChannel,

float fLevelIndB

);


 

[C++]

public: enumErrorCodes CapturePartChannelVolumeSet (

Int16 nDeviceIndex,

enumCoreAudioCaptureParts nPartId,

Int16 nChannel,

float fLevelIndB

);


 

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.

If this parameter is set to -1 the volume level is applied to all of the available channels.

fLevelIndB

The new level, expressed in dB, of the Microphone Boost setting.

The range of acceptable values to apply can be determined by checking the fRangeMinIndB and fRangeMaxIndB parameters of the CoreAudioDevices.MicBoostChannelLevelGet method.

 

 

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.