Skip to content

Pylon::SAviCompressionOptions#

Module: Image Handling Support

Wraps the AVI compression options of the Video for Window API.

#include <pylon/AviCompressionOptions.h>

Public Functions#

Name
SAviCompressionOptions(bool optionalShowDialog =false, HWND optionalHParentWindow =NULL)
Create the compression options structure.
SAviCompressionOptions(const char * fourCharacterCode, bool optionalShowDialog =false, HWND optionalHParentWindow =NULL)
Create the compression options structure.

Public Attributes#

Name
HWND hParentWindow
Optional handle to the parent window for the Compression Options dialog box. See the Video for Windows API AviSaveOptions() MSDN documentation.
bool showDialog
Optionally show Compression Options dialog box. See the Video for Windows API AviSaveOptions() MSDN documentation.
bool userDialogReturnOk
Is set to true in the call to the CAviWriter::Open() method if the user pressed OK in the dialog. The compression is not set up if cancel has been pressed.
LONG autoKeyFrameInsertionRate
Indicates to insert a key frame every nth image when KeyFrameSelection_Auto is used.
AVICOMPRESSOPTIONS compressionOptions

Public Functions Documentation#

SAviCompressionOptions#

inline SAviCompressionOptions(
    bool optionalShowDialog =false,
    HWND optionalHParentWindow =NULL
)

Create the compression options structure.

Parameters:

  • optionalShowDialog Optionally show the Compression Options dialog box. The dialog allows to set the compression parameters. See the Video for Windows API AviSaveOptions() MSDN documentation.
  • optionalHParentWindow Optional handle to the parent window for the Compression Options dialog box. See the Video for Windows API AviSaveOptions() MSDN documentation.

To use compression set up the AVICOMPRESSOPTIONS structure. You can use the dialog provided by the Video for Windows API to do this by setting optionalShowDialog to true. Alternatively, fill the AVICOMPRESSOPTIONS structure with the four character code identifying the codec and the parameter settings of the codec. For more information, see the MSDN documentation of the Video for Windows API and the documentation of the codec you are using.

SAviCompressionOptions#

inline SAviCompressionOptions(
    const char * fourCharacterCode,
    bool optionalShowDialog =false,
    HWND optionalHParentWindow =NULL
)

Create the compression options structure.

Parameters:

  • fourCharacterCode The four character code identifying the codec to use for compression.
  • optionalShowDialog Optionally show the Compression Options dialog box. The dialog allows to set the compression parameters. See the Video for Windows API AviSaveOptions() MSDN documentation.
  • optionalHParentWindow Optional handle to the parent window for the Compression Options dialog box. See the Video for Windows API AviSaveOptions() MSDN documentation.

Preset some compression options.

To use compression set up the AVICOMPRESSOPTIONS structure. You can use the dialog provided by the Video for Windows API to do this by setting optionalShowDialog to true. Alternatively, fill the AVICOMPRESSOPTIONS structure with the four character code identifying the codec and the parameter settings of the codec. For more information, see the MSDN documentation of the Video for Windows API and the documentation of the codec you are using.

Public Attributes Documentation#

hParentWindow#

HWND hParentWindow;

Optional handle to the parent window for the Compression Options dialog box. See the Video for Windows API AviSaveOptions() MSDN documentation.

showDialog#

bool showDialog;

Optionally show Compression Options dialog box. See the Video for Windows API AviSaveOptions() MSDN documentation.

userDialogReturnOk#

bool userDialogReturnOk;

Is set to true in the call to the CAviWriter::Open() method if the user pressed OK in the dialog. The compression is not set up if cancel has been pressed.

autoKeyFrameInsertionRate#

LONG autoKeyFrameInsertionRate;

Indicates to insert a key frame every nth image when KeyFrameSelection_Auto is used.

compressionOptions#

AVICOMPRESSOPTIONS compressionOptions;

The AVICOMPRESSOPTIONS structure needs to be set up with the four character code identifying the codec and the parameter settings of the codec. For more information, see the MSDN documentation of the Video for Windows API and the documentation of the codec you are using.


Updated on 5 July 2022 at 15:30:01