Copyright © 2005-2018 MultiMedia Soft

BeatsDetectEnableRT method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disables real-time detection (during playback) of beats positions. The CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to EV_BEAT_DETECTED each time the control detects a beat during playback.

 

Parameters for beats positions analysis can be obtained/set through the BeatsDetectGetParams and BeatsDetectSetParams methods.

 

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

 

 

Syntax

 

[Visual Basic]

Public Function BeatsDetectEnableRT (

nPlayerIndex as Int16,

bEnable as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes BeatsDetectEnableRT (

Int16 nPlayerIndex,

bool bEnable

);


 

[C++]

public: enumErrorCodes BeatsDetectEnableRT (

Int16 nPlayerIndex,

bool bEnable

);


 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

bEnable

Boolean value that specifies if the control must automatically detect beats positions during playback.

Supported values are the following:

Mnemonic constant

Meaning

false (default)

Beats detection is disabled

true

Beats detection is enabled

 

 

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.