Copyright © 2005-2018 MultiMedia Soft

BeatsDetectRequest method

Previous pageReturn to chapter overviewNext page

Remarks

 

Analyses a given range of the loaded sound in order to identify and store beats positions. In this case beats positions detection is performed offline, i.e. while the sound is not being played: if you should need detecting beats positions in real-time during playback, use the BeatsDetectEnableRT method.

 

Parameters for beats positions analysis can be obtained/set through the BeatsDetectGetParams and BeatsDetectSetParams methods and the range of sound to analyze can be set through the BeatsDetectSetRange method.

Once beats positions have been calculated, the container application is notified through the CallbackForPlayersEvents delegate having the nEvent parameter set to EV_BEATS_AVAILABLE.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function BeatsDetectRequest (

nPlayerIndex as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes BeatsDetectRequest (

Int16 nPlayerIndex

);


 

[C++]

public: enumErrorCodes BeatsDetectRequest (

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.