Copyright © 2006-2010 MultiMedia Soft

WaveformAnalyzer.CreateFileBitmapView method

Previous pageReturn to chapter overviewNext page

Remarks

 

Creates a view of the waveform (in form of a BMP file) for the recorded sound: the view can represent the full sound's waveform or portions of it.

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 WaveAnalysisDone 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 object section.

 

 

Syntax

 

[Visual Basic]

control.WaveformAnalyzer.CreateFileBitmapView (

nStartPos as integer,

nEndPos as integer,

nBitmapWidth as integer,

nBitmapHeight as integer,

nWaveformType as enumWaveformTypes,

strPathname as string

) as enumErrorCodes


 

[C++]

short control.WaveformAnalyzer.CreateFileBitmapView (

long nStartPos,

long nEndPos,

long nBitmapWidth,

long nBitmapHeight,

short nWaveformType,

LPCTSTR strPathname

);


 

 

Parameter

Description

 

 

nStartPos

Number representing the sound's position, expressed in milliseconds, where the waveform visualization begins.

The value 0 represents the sound's beginning.

nEndPos

Number representing the sound's position, expressed in milliseconds, where the waveform visualization ends.

The value -1 represents the sound's end.

nBitmapWidth

Number representing the generated bitmap width, expressed in pixels. A value of -1 indicates no width constraints: in this case the control will generate a bitmap large enough in order to contain the full sound's waveform.

nBitmapHeight

Number representing the generated bitmap height, expressed in pixels.

nWaveformType

The type of rendered waveform, related to the sound's channels.

Supported values are the following:

Mnemonic value

Value

Meaning

WAVEFORM_TYPE_LEFT

0

The bitmap contains sound data for the left channel

WAVEFORM_TYPE_RIGHT

1

The bitmap contains sound data for the right channel

WAVEFORM_TYPE_MIXED

2

The bitmap contains sound data for left and right mixed channels

strPathname

String containing the absolute pathname of the BMP file where the waveform will be saved.

 

 

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