Methods > Init, info and tags > RequestSoundBPM method

Remarks

Analyses the loaded song BPM (Beats Per Minute): useful when the automatic BPM detection has been disabled through a call to the SetAutomaticBPM method.

This method doesn't work with sounds with more than 2 channels (5.1 or 7.1) or if the EnableMixingFeatures property has been set to false.

Once the BPM has been calculated, the container application will be notified about the detected BPM through the CallbackForPlayersEvents delegate which is invoked with the nEvent parameter set to EV_BPM_AVAILABLE.

For further details about BPM detection refer to the How to detect beats positions and BPM tutorial.

Syntax

[Visual Basic]

Public Function RequestSoundBPM (

nPlayerIndex as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes RequestSoundBPM (

Int16 nPlayerIndex

);

[C++]

public: enumErrorCodes RequestSoundBPM (

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.