Remarks
Saves into a graphic file a screenshot of what is currently displayed on the window of the given video mixer, including eventual graphic items displayed on the OSD.
For further details about the use of the embedded video mixer see the VideoMixer object section.
For details about video mixing/blending refer to the How to use the video mixer tutorial.
Syntax
[Visual Basic]
control.VideoMixer.ScreenshotSaveToFile (
nMixerUniqueId as Long,
strPathname as String,
nFormat as enumGraphicFormats,
nFormatParameter as long
) as enumErrorCodes
|
|
[C++]
short control.VideoMixer.ScreenshotSaveToFile (
long nMixerUniqueId,
LPCTSTR strPathname,
short nFormat,
long nFormatParameter
);
|
|
Parameter
|
Description
|
|
|
nMixerUniqueId
|
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method
|
strPathname
|
String containing the absolute pathname where the screenshot will be stored.
|
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
|
|
