Copyright © 2005-2018 MultiMedia Soft

VuMeter.KeepCountOfVolume method

Previous pageReturn to chapter overviewNext page

Remarks

 

Specifies if the VU-Meter must keep count of the volume set into the DirectSound buffer of the given player, through a previous call to the StreamVolumeDirectSoundBufferSet method, in order to calculate the volume level. This method has no effect without a previous call to the VUMeter.Create method.

 

For further details about using the embedded VU-Meter refer to the VUMeter class section.

For details about using Visual Feedbacks refer to the How to use the embedded Visual Feedbacks section.

 

 

Syntax

 

[Visual Basic]

Public Function KeepCountOfVolume (

nPlayerIndex as Int16,

bKeepCountOfVolume as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes KeepCountOfVolume (

Int16 nPlayerIndex,

bool bKeepCountOfVolume

);


 

[C++]

public: enumErrorCodes KeepCountOfVolume (

Int16 nPlayerIndex,

bool bKeepCountOfVolume

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the player that will use the VU-Meter

bKeepCountOfVolume

Boolean flag that specifies if the VU-Meter must keep count of volume.

Supported values are the following:

Value

Meaning

false

Doesn't keep count of volume set through the StreamVolumeDirectSoundBufferSet method: in this case the VU-Meter will always display the original volume level of the sound being played.

true (default)

Keeps count of volume: in this case any change to the player's volume performed through the StreamVolumeDirectSoundBufferSet method will be reflected into the visualization of the VU-meter and into values reported by the VUMeterValueChange event.

 

 

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.