Copyright © 2001-2018 MultiMedia Soft

CoreAudioDevices.RenderPartChannelVolumeGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the channel's level of a part embedded inside the given render audio endpoint device. The current level for the same part can be modified through the CoreAudioDevices.RenderPartChannelVolumeSet 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 CoreAudioDevices COM object.

 

 

Syntax

 

[Visual Basic]

control.CoreAudioDevices.RenderPartChannelVolumeGet (

nDeviceIndex as Integer,

nPartId as enumCoreAudioRenderParts,

nChannel as Integer,

fLevelIndB as Single,

fRangeMinIndB as Single,

fRangeMaxIndB as Single,

fSteppingIndB as Single

) as enumErrorCodes


 

[C++]

short control.CoreAudioDevices.RenderPartChannelVolumeGet (

short nDeviceIndex,

short nPartId,

short nChannel,

float *fLevelIndB,

float *fRangeMinIndB,

float *fRangeMaxIndB,

float *fSteppingIndB

);


 

Parameter

Description

 

 

nDeviceIndex

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

nPartId

Identifier of the render part.

Supported values are the following:

Mnemonic Value

Value

Meaning

RENDER_PART_CD_AUDIO

0

CD Audio

RENDER_PART_MIC

1

Microphone

RENDER_PART_LINEIN

2

Line In

nChannel

Zero-based index of the channel. The total number of channels can be obtained through the CoreAudioDevices.RenderPartChannelCountGet 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, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful