WaveformAnalyzer.GetBitmapViewWidth method

WaveformAnalyzer.GetBitmapViewWidth method

Remarks

Given a range in milliseconds, calculates the number of pixels required for displaying the waveform's view.

The returned value can be assigned to the nBitmapWidth parameter of the WaveformAnalyzer.CreateFileBitmapView and WaveformAnalyzer.CreateMemoryBitmapView methods.

Before calling this method it's mandatory performing a previous sound's analysis through a call to the WaveformAnalyzer.AnalyzeFullSound method and waiting its completion through the WaveAnalysisStop event.

For further details about generating a waveform bitmap of the recorded sound refer to the How to obtain the waveform bitmap of the latest recording session tutorial.

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 GetBitmapViewWidth (

nStartPos as Int32,

nEndPos as Int32

) as Int32

[C#]

public Int32 GetBitmapViewWidth (

Int32 nStartPos,

Int32 nEndPos

);

[C++]

public: Int32 GetBitmapViewWidth (

Int32 nStartPos,

Int32 nEndPos

);

Parameter	Description

nStartPos	Number representing the sound's position, expressed in milliseconds, where the waveform's view begins. The value 0 represents the sound's beginning.
nEndPos	Number representing the sound's position, expressed in milliseconds, where the waveform's view ends. The value -1 represents the sound's end.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
Value > 0	The method call was successful and the returned value represents the width in pixels of the waveform's view

Return to Table of contents