Copyright © 2008-2019 MultiMedia Soft

WaveformAnalyzer.SnapshotWindowSaveToFile method

Previous pageReturn to chapter overviewNext page

Remarks

 

Creates a graphic file containing a snapshot of the full waveform analyzer window as seen on the user interface.

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

strPathname as string,

nFormat as enumGraphicFormats,

nFormatParameter as Long

) as enumErrorCodes


 

[C#]

public enumErrorCodes SnapshotWindowSaveToFile (

string strPathname,

enumGraphicFormats nFormat,

Int32 nFormatParameter

);


 

[C++]

public: enumErrorCodes SnapshotWindowSaveToFile (

string strPathname,

enumGraphicFormats nFormat,

Int32 nFormatParameter

);


 

 

Parameter

Description

 

 

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.