|
Effects.NormalizationPeakSet method |
  
|
|
Effects.NormalizationPeakSet method |
|
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:
- 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] Public Function NormalizationPeakSet ( nPlayerIndex as Int16, fPeak as Single ) as enumErrorCodes |
[C#] public enumErrorCodes NormalizationPeakSet ( Int16 nPlayerIndex, float fPeak ); |
[C++] public: enumErrorCodes NormalizationPeakSet ( Int16 nPlayerIndex, float fPeak ); |
Parameter |
Description |
|
|
nPlayerIndex |
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.NOERROR (0) |
The method call was successful |
