Classes > Waveform class > Methods > Waveform.AnalyzeAbort method

Remarks

Aborts a running analysis of the loaded sound.

This method call will cause the CallbackForPlayersEvents delegate to be invoked with the nEvent parameter set to EV_WAVE_ANALYSIS_DONE

For further details about generating a waveform bitmap of the loaded sound, before starting its playback, refer to the How to obtain the sound's waveform tutorial.

Syntax

[Visual Basic]

Public Function AnalyzeAbort (

nPlayerIndex as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes AnalyzeAbort (

Int16 nPlayerIndex

);

[C++]

public: enumErrorCodes AnalyzeAbort (

Int16 nPlayerIndex

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the Waveform

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.