Classes > CoreAudioDevicesMan class > Methods > CoreAudioDevices.VuMeterMasterPeakValueGet method

Remarks

Obtains the master VU-Meter's peak value for the given audio endpoint device. You can be informed about changes of VU-meters peaks by enabling notification about VU-meters changes (through the CoreAudioDevices.VuMeterEnableNotifications method) and through CallbackForCoreAudioEvents delegate having the nEvent parameter set to EV_COREAUDIO_DEVICE_VUMETER_CHANGE.

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

nDataFlow as enumCoreAudioDataFlows,

nDeviceIndex as Int16,

fPeakValue as Single

) as enumErrorCodes

[C#]

public enumErrorCodes VuMeterMasterPeakValueGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

ref float fPeakValue

);

[C++]

public: enumErrorCodes VuMeterMasterPeakValueGet (

enumCoreAudioDataFlows nDataFlow,

Int16 nDeviceIndex,

float __gc *fPeakValue

);

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.

fPeakValue

Reference that, on return from the method call, will contain the the master peak value.

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.