Copyright © 2006-2018 MultiMedia Soft

WaveformAnalyzer.SnapshotViewSaveToFile method

Previous pageReturn to chapter overviewNext page

Remarks

 

Creates a graphic file containing a snapshot of the bitmap view of the analysed sound waveform: 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 details about generating a waveform bitmap of the recorded sound and 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 SnapshotViewSaveToFile (

nMode as enumWaveSnapshotViewMode,

nStartPos as Int32,

nEndPos as Int32,

nBitmapWidth as Int32,

nBitmapHeight as Int32,

nChannel as enumWaveformChannels,

strPathname as string,

nFormat as enumGraphicFormats,

nFormatParameter as Long

) as enumErrorCodes


 

[C#]

public enumErrorCodes SnapshotViewSaveToFile (

enumWaveSnapshotViewMode nMode,

Int32 nStartPos,

Int32 nEndPos,

Int32 nBitmapWidth,

Int32 nBitmapHeight,

enumWaveformChannels nChannel

string strPathname,

enumGraphicFormats nFormat,

Int32 nFormatParameter

);


 

[C++]

public: enumErrorCodes SnapshotViewSaveToFile (

enumWaveSnapshotViewMode nMode,

Int32 nStartPos,

Int32 nEndPos,

Int32 nBitmapWidth,

Int32 nBitmapHeight,

enumWaveformChannels nChannel

string strPathname,

enumGraphicFormats nFormat,

Int32 nFormatParameter

);


 

 

Parameter

Description

 

 

nMode

Snapshot view mode.

Supported values are the following:

Mnemonic value

Value

Meaning

WAVE_SNAPSHOT_MODE_WAVEFORM

0

Snapshot of the waveform

WAVE_SNAPSHOT_MODE_SPECTRAL

1

Snapshot of the spectral view

WAVE_SNAPSHOT_MODE_WAVEFORM_ABS

2

Snapshot of the waveform with absolute values

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.

nChannel

Audio channel to render.

Supported values are the following:

Mnemonic value

Value

Meaning

WAVEFORM_CHAN_ALL

-2

The snapshot contains sound data for all channels separated

WAVEFORM_CHAN_MIXED

-1

The snapshot contains sound data for all channels mixed together

WAVEFORM_CHAN_0

0

The snapshot contains sound data for channel 0 or left channel for stereo

WAVEFORM_CHAN_1

1

The snapshot contains sound data for channel 1 or right channel for stereo

WAVEFORM_CHAN_2

2

The snapshot contains sound data for channel 2

WAVEFORM_CHAN_3

3

The snapshot contains sound data for channel 3

WAVEFORM_CHAN_4

4

The snapshot contains sound data for channel 4

WAVEFORM_CHAN_5

5

The snapshot contains sound data for channel 5

WAVEFORM_CHAN_6

6

The snapshot contains sound data for channel 6

WAVEFORM_CHAN_7

7

The snapshot contains sound data for channel 7

strPathname

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

nFormat

Graphic format used to save the bitmap.

Supported values are the following:

Mnemonic value

Value

Meaning

GRAPHIC_FORMAT_BMP

0

BMP format

GRAPHIC_FORMAT_JPEG

1

JPEG format

GRAPHIC_FORMAT_PNG

2

PNG format

GRAPHIC_FORMAT_GIF

3

GIF format

GRAPHIC_FORMAT_TIFF

4

TIFF format

nFormatParameter

Eventual parameters required by the chosen graphic format.

 

When the nFormat parameter is set to GRAPHIC_FORMAT_JPEG, this parameter defines the JPEG compression factor whose range can be in the range from 0 (Maximum compression, Lower Quality) to 100 (Minimum compression, Higher Quality).

 

 

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 and the waveform's bitmap was saved inside the BMP file indicated by the strPathname parameter.