Remarks
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.
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.
Syntax
[Visual Basic]
Public Function BitmapViewSaveToFile (
nPlayerIndex as Int16,
nStartPos as Int32,
nEndPos as Int32,
nBitmapWidth as Int32,
nBitmapHeight as Int32,
nWaveformType as enumWaveformTypes,
strPathname as string,
nFormat as enumGraphicFormats,
nFormatParameter as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes BitmapViewSaveToFile (
Int16 nPlayerIndex,
Int32 nStartPos,
Int32 nEndPos,
Int32 nBitmapWidth,
Int32 nBitmapHeight,
enumWaveformTypes nWaveformType,
string strPathname,
enumGraphicFormats nFormat,
long nFormatParameter
);
|
|
[C++]
public: enumErrorCodes BitmapViewSaveToFile (
Int16 nPlayerIndex,
Int32 nStartPos,
Int32 nEndPos,
Int32 nBitmapWidth,
Int32 nBitmapHeight,
enumWaveformTypes nWaveformType,
string strPathname,
enumGraphicFormats nFormat,
long nFormatParameter
);
|
|
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 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.NOERROR (0)
|
The method call was successful and the waveform's bitmap was saved inside the BMP file indicated by the strPathname parameter.
|
|
