Spinnaker C++
4.0.0.116
Public Member Functions | List of all members
SpinVideo Class Reference

Provides the functionality for the user to record images to an AVI/MP4 file. More...

Public Member Functions

 SpinVideo ()
 Default constructor. More...
 
virtual ~SpinVideo ()
 Default destructor. More...
 
virtual void Open (const char *pFileName, AVIOption &pOption)
 Open an video file in preparation for writing Images to disk. More...
 
virtual void Open (const char *pFileName, MJPGOption &pOption)
 Open an MJPEG video file in preparation for writing Images to disk. More...
 
virtual void Open (const char *pFileName, H264Option &pOption)
 Open an H264 MP4 video file in preparation for writing Images to disk. More...
 
virtual void Append (ImagePtr pImage)
 Append an image to the video file. More...
 
virtual void Close ()
 Close the video file. More...
 
virtual void SetMaximumFileSize (unsigned int size)
 Set the maximum file size (in megabytes) of a AVI/MP4 file. More...
 

Detailed Description

Provides the functionality for the user to record images to an AVI/MP4 file.

Examples:
SaveToAvi.cpp.

Constructor & Destructor Documentation

SpinVideo ( )

Default constructor.

virtual ~SpinVideo ( )
virtual

Default destructor.

Member Function Documentation

virtual void Append ( ImagePtr  pImage)
virtual

Append an image to the video file.

When using the H264 encoder, several images are required to be appended before the encoder is able to output the first encoded frame.

Parameters
pImageThe image to append.
Examples:
SaveToAvi.cpp.
virtual void Close ( )
virtual

Close the video file.

This function will throw an exception when the H264 encoder was unable to output any encoded frames, in which case the output video should be considered invalid.

See Also
Open()
Append(ImagePtr pImage)
Examples:
SaveToAvi.cpp.
virtual void Open ( const char *  pFileName,
AVIOption pOption 
)
virtual

Open an video file in preparation for writing Images to disk.

The size of video files is limited to 2GB. The filenames are automatically generated using the filename specified.

Parameters
pFileNameThe filename of the video file.
pOptionOptions to apply to the video file.
See Also
Close()
Examples:
SaveToAvi.cpp.
virtual void Open ( const char *  pFileName,
MJPGOption pOption 
)
virtual

Open an MJPEG video file in preparation for writing Images to disk.

The size of video files is limited to 2GB. The filenames are automatically generated using the filename specified.

Parameters
pFileNameThe filename of the video file.
pOptionMJPEG options to apply to the video file.
See Also
Close()
MJPGOption
virtual void Open ( const char *  pFileName,
H264Option pOption 
)
virtual

Open an H264 MP4 video file in preparation for writing Images to disk.

The size of MP4 files is limited to 2GB. The filenames are automatically generated using the filename specified.

Parameters
pFileNameThe filename of the MP4 video file.
pOptionH264 options to apply to the MP4 video file.
See Also
Close()
H264Option
virtual void SetMaximumFileSize ( unsigned int  size)
virtual

Set the maximum file size (in megabytes) of a AVI/MP4 file.

A new video file is created automatically when file size limit is reached. Setting a maximum size of 0 indicates no limit on file size.

Note that this size serves only as a hint and can still be slightly exceeded in some cases after the video trailer is written.

Parameters
sizeThe maximum video file size in MB.
See Also
Append(ImagePtr pImage)
Examples:
SaveToAvi.cpp.

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference