Copyright © 2001-2019 MultiMedia Soft

Effects.NormalizationPeakSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

When normalization has been enabled through the Effects.NormalizationEnable method, sets the highest peak for performing real-time normalization of songs in playback.

 

The value to pass to this method for a specific sound file can be previously calculated through one of the following methods:

- PeakDetectionOnFile

- PeakDetectionOnPlayer

- PeakDetectionOnPlayerRequest

 

This method must be invoked before invoking the LoadSound or LoadSoundFromMemory methods.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

control.Effects.NormalizationPeakSet (

nPlayer as Integer,

fPeak as Single

) as enumErrorCodes


 

[C++]

short control.Effects.NormalizationPeakSet (

short nPlayer,

float fPeak

);


 

 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

fPeak

Highest peak value, can be in the range from 0.0 to 1.0

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The call was successful.