Methods > Waveform analysis > ExternalSoundAnalysisStop method

Remarks

Stops receiving sound data provided by an external source and starts a sound waveform analysis.

Syntax

[Visual Basic]

Public Function ExternalSoundAnalysisStop (

bSuccess as Boolean

) as enumWanErrorCodes

[C#]

public enumWanErrorCodes ExternalSoundAnalysisStop (

bool bSuccess

);

[C++]

public: enumWanErrorCodes ExternalSoundAnalysisStop (

bool 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

false

The transfer of PCM sound data needs to be aborted.

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 last error.
enumWanErrorCodes.ERR_WAN_NOERROR (0)	The method call was successful.