Methods > Waveform analysis > ExternalSoundAnalysisStop method

Remarks

Starts the analysis of the given RAW audio file.

A successful call to this method will fire the WaveAnalysisStart event followed by a number of WaveAnalysisPerc events and finally by the WaveAnalysisDone event.

Syntax

[Visual Basic]

control.ExternalSoundAnalysisStop (

bSuccess as enumBoolean

) as enumWanErrorCodes

[C++]

short control.ExternalSoundAnalysisStop (

short bSuccess

);

Parameter

Description

bSuccess

Boolean flag that specifies if this stop can be considered as a successful conclusion of the PCM sound data transfer, meaning that the waveform analysis can be started, or if the stop can be considered as an abort operation.

Supported values are the following:

Mnemonic Value

Meaning

BOOL_FALSE

The transfer of PCM sound data needs to be aborted.

BOOL_TRUE

The transfer of PCM sound data from the external source is completed and the waveform analysis can be started.

Before invoking this method the container application must have invoked the ExternalSoundAnalysisStart method followed by one or more calls to the ExternalSoundAnalysisPushData method.

In this situation the control will fire the WaveAnalysisStart event followed by a number of WaveAnalysisPerc events and finally by the WaveAnalysisDone event.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to see the error code meaning
enumWanErrorCodes.ERR_WAN_NOERROR (0)	The method call was successful.