|
PeakDetectionOnPlayerRequest method |
  
|
|
PeakDetectionOnPlayerRequest method |
|
Remarks
Requests the highest peak of the sound currently loaded inside the given player.
Differently from the PeakDetectionOnPlayer method, the value of the highest peak is not immediately available when this method returns to the caller: when available, the calculated value will be notified to the container application through the fData3 parameter of the CallbackForPlayersEvents delegate, invoked with the nEvent parameter set to EV_PEAK_AVAILABLE.
The calculated value can be used with the Effects.NormalizationPeakSet method to speed up a later loading of a sound file when normalization has been enabled through the Effects.NormalizationEnable method.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function PeakDetectionOnPlayerRequest ( nPlayerIndex as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes PeakDetectionOnPlayerRequest ( Int16 nPlayerIndex ); |
[C++] public: enumErrorCodes PeakDetectionOnPlayerRequest ( Int16 nPlayerIndex ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
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 |
