Waveform.CreateFileBitmapView method

Waveform.CreateFileBitmapView method

Creates a view of the waveform (in form of a BMP file) for the sound loaded inside the given player: 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 Waveform.AnalyzeFullSound method and waiting its completion through the WaveAnalysisStop event.

For further details about generating a waveform bitmap of the loaded sound, before starting its playback, refer to the How to obtain the sound's waveform tutorial.

[Visual Basic]

Public Function CreateFileBitmapView (

nPlayerIndex as Int16,

nStartPos as Int32,

nEndPos as Int32,

nBitmapWidth as Int32,

nBitmapHeight as Int32,

nWaveformType as enumWaveformTypes,

strPathname as string

) as enumErrorCodes

[C#]

public enumErrorCodes CreateFileBitmapView (

Int16 nPlayerIndex,

Int32 nStartPos,

Int32 nEndPos,

Int32 nBitmapWidth,

Int32 nBitmapHeight,

enumWaveformTypes nWaveformType,

string strPathname

);

[C++]

public: enumErrorCodes CreateFileBitmapView (

Int16 nPlayerIndex,

Int32 nStartPos,

Int32 nEndPos,

Int32 nBitmapWidth,

Int32 nBitmapHeight,

enumWaveformTypes nWaveformType,

string strPathname

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the player that will use the Waveform

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 aboslute pathname of the BMP file where the waveform will be saved.

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful and the waveform's bitmap was saved inside the BMP file indicated by the strPathname parameter.