Copyright © 2005-2019 MultiMedia Soft

SetAutomaticBPM method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enable/disables the automatic BPM (Beat Per Minute) detection during the loading of a sound through one of the many methods having the "Load" prefix like LoadSound or LoadSoundFromMemory: the automatic BPM detection is enabled by default: disabling the automatic BPM detection will result in a faster load.

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.

 

When the automatic BPM detection is enabled, 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.

 

When the automatic BPM detection is disabled, the loaded song BPM can be requested at any time using the RequestSoundBPM method.

 

 

Syntax

 

[Visual Basic]

Public Sub SetAutomaticBPM (

bAutomatic as Boolean

)


 

[C#]

public void SetAutomaticBPM (

bool bAutomatic

);


 

[C++]

public: void SetAutomaticBPM (

bool bAutomatic

);


 

 

Parameter

Description

 

 

bAutomatic

Boolean value that specifies to execute the automatic BPM detection

Supported values are the following:

Value

Meaning

false

Automatic BPM detection is disabled

true

Automatic BPM detection is enabled (default)

 

Return value

 

None