Copyright © 2001-2019 MultiMedia Soft

PeakDetectionOnPlayerRequest method

Previous pageReturn to chapter overviewNext page

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 NormalizationPeakAvailable event.

 

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]

control.PeakDetectionOnPlayerRequest (

nPlayer as Integer

) as enumErrorCodes


 

[C++]

short control.PeakDetectionOnPlayerRequest (

short nPlayer

);


 

 

Parameter

Description

 

 

nPlayer

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