Copyright © 2006-2018 MultiMedia Soft

WaveformAnalyzer.SetSelection method

Previous pageReturn to chapter overviewNext page

Remarks

 

Changes the portion of waveform currently selected through the tracker. The current selection, if any, can be retrieved calling the WaveformAnalyzer.GetSelection method.

 

After a call to this method the CallbackWaveformAnalyzerSelection delegate is invoked.

 

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

 

 

Syntax

 

[Visual Basic]

Public Function SetSelection (

bSelectionAvailable as Boolean,

nBeginPosInMs as Int32,

nEndPosInMs as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes SetSelection (

bool bSelectionAvailable,

Int32 nBeginPosInMs,

Int32 nEndPosInMs

);


 

[C++]

public: enumErrorCodes SetSelection (

bool bSelectionAvailable,

Int32 nBeginPosInMs,

Int32 nEndPosInMs

);


 

 

Parameter

Description

 

 

bSelectionAvailable

Flag for selection availability.

Supported values are the following:

Value

Meaning

false

Remove the current selection, if any. In this case values passed through nBeginPosInMs and nEndPosInMs parameters are ignored.

true

Perform a new selection using values stored inside nBeginPosInMs and nEndPosInMs parameters

nBeginPosInMs

The selection's start position, expressed in milliseconds

nEndPosInMs

The selection's end position, expressed in milliseconds

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful