Vuo  1.2.8
Public Member Functions | List of all members
VuoMovieExporter Class Reference

Description


Runs an Image Generator composition in a separate process, saving each output image to a movie file.

Example:
while (e.exportNextFrame());

Public Member Functions

 VuoMovieExporter (std::string compositionFile, std::string outputMovieFile, VuoMovieExporterParameters parameters)
 Initializes a movie exporter instance with a composition file. More...
 
 VuoMovieExporter (std::string compositionString, std::string name, std::string sourcePath, std::string outputMovieFile, VuoMovieExporterParameters parameters)
 Initializes a movie exporter instance with a composition in a string. More...
 
 ~VuoMovieExporter ()
 Finalizes the movie. More...
 
unsigned int getTotalFrameCount (void)
 Returns the total number of frames to export. More...
 
bool exportNextFrame (void)
 Exports 1 frame. More...
 

Constructor & Destructor Documentation

◆ VuoMovieExporter() [1/2]

VuoMovieExporter::VuoMovieExporter ( std::string  compositionFile,
std::string  outputMovieFile,
VuoMovieExporterParameters  parameters 
)

Initializes a movie exporter instance with a composition file.

◆ VuoMovieExporter() [2/2]

VuoMovieExporter::VuoMovieExporter ( std::string  compositionString,
std::string  name,
std::string  sourcePath,
std::string  outputMovieFile,
VuoMovieExporterParameters  parameters 
)

Initializes a movie exporter instance with a composition in a string.

◆ ~VuoMovieExporter()

VuoMovieExporter::~VuoMovieExporter ( )

Finalizes the movie.

Exceptions
std::runtime_errorCouldn't finalize the movie.
Todo:
Replace with -finishWritingWithCompletionHandler: when we drop Mac OS 10.8 support.

Member Function Documentation

◆ exportNextFrame()

bool VuoMovieExporter::exportNextFrame ( void  )

Exports 1 frame.

Returns false if enough frames have already been exported.

Exceptions
std::runtime_errorCouldn't generate the image.
std::runtime_errorCouldn't convert the frame for export.

◆ getTotalFrameCount()

unsigned int VuoMovieExporter::getTotalFrameCount ( void  )

Returns the total number of frames to export.


The documentation for this class was generated from the following files: