VRS::AVIMaker Class Reference
Writer for "Video for Windows" files. More...
#include <vrs/image/avimaker.h>
Public Member Functions | |
| AVIMaker (GLCanvas *masterCanvas) | |
| AVIMaker (GLCanvas *masterCanvas, const std::string &filename, int frameRate=20, bool highQuality=false, VideoCompressor *compressor=NULL) | |
| virtual | ~AVIMaker () |
| virtual BehaviorNode::InvalidationHint | handle (Event *event) |
| next frame is recorded if 1.0/framerate time has pased | |
| void | open (const std::string &filename, int frameRate=15, bool highQuality=false, VideoCompressor *compressor=NULL) |
| void | close () |
| closes AVI stream | |
| bool | isOpen () const |
| check if AVI stream is opened | |
| GLCanvas * | canvas () const |
| returns the canvas that was used to construct the AVIMaker object | |
| const std::string & | filename () const |
| returns the filename of the AVI | |
| int | frameRate () const |
| returns the frame rate of the AVI | |
| int | currentFrameNo () const |
| returns the number of frames that have been already written | |
| VRS_TYPEINFO (AVIMaker, BehaviorNode) | |
Static Public Member Functions | |
| static Iterator< std::string > * | availableCompressors () |
| Returns the names of the supported video codecs installed on this system. | |
| static VideoCompressor * | getCompressor (const std::string &compressor) |
Detailed Description
Writer for "Video for Windows" files.Constructor & Destructor Documentation
| VRS::AVIMaker::AVIMaker | ( | GLCanvas * | masterCanvas | ) |
| VRS::AVIMaker::AVIMaker | ( | GLCanvas * | masterCanvas, | |
| const std::string & | filename, | |||
| int | frameRate = 20, |
|||
| bool | highQuality = false, |
|||
| VideoCompressor * | compressor = NULL | |||
| ) |
| virtual VRS::AVIMaker::~AVIMaker | ( | ) | [virtual] |
The default constructor creates an empty avi stream object. Use open to create the actual avi stream. The second constructor of the AVIMaker expects the video file name and the frame rate at which that video should be played later. Optionally, a VideoCompressor can be specified. If no VideoCompressor is provided, a Window dialog asks for the compression method to be applied to that video stream. If highQuality is true the streams dimensions are only half of the canvas dimension. use this parameter to create pseudo anti-aliasing effect. The AVIMaker state is inactive at default. Note: Some installed compression methods may have special constraints, e.g., pow2 width and height. Look at the compression method documentation.
Member Function Documentation
| virtual BehaviorNode::InvalidationHint VRS::AVIMaker::handle | ( | Event * | event | ) | [virtual] |
| void VRS::AVIMaker::open | ( | const std::string & | filename, | |
| int | frameRate = 15, |
|||
| bool | highQuality = false, |
|||
| VideoCompressor * | compressor = NULL | |||
| ) |
Opens the AVI stream. If no VideoCompressor is provided, a dialog asks for the compression method to use.
| void VRS::AVIMaker::close | ( | ) |
closes AVI stream
| bool VRS::AVIMaker::isOpen | ( | ) | const |
check if AVI stream is opened
| GLCanvas* VRS::AVIMaker::canvas | ( | ) | const |
returns the canvas that was used to construct the AVIMaker object
| const std::string& VRS::AVIMaker::filename | ( | ) | const |
returns the filename of the AVI
| int VRS::AVIMaker::frameRate | ( | ) | const |
returns the frame rate of the AVI
| int VRS::AVIMaker::currentFrameNo | ( | ) | const |
returns the number of frames that have been already written
| static Iterator<std::string>* VRS::AVIMaker::availableCompressors | ( | ) | [static] |
Returns the names of the supported video codecs installed on this system.
| static VideoCompressor* VRS::AVIMaker::getCompressor | ( | const std::string & | compressor | ) | [static] |
Returns a new VideoCompressor of the specified type. Warning: Should only be used with the compressor names returned by availableCompressors().
| VRS::AVIMaker::VRS_TYPEINFO | ( | AVIMaker | , | |
| BehaviorNode | ||||
| ) |
The documentation for this class was generated from the following file: