Vuo  1.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
VuoMovieExporterParameters Class Reference

Description

Parameters specifying how an Image Generator composition should be rendered into a movie.

Public Types

enum  ImageFormat { H264, JPEG, ProRes4444, ProRes422 }
 Movie export codecs. More...
 

Public Member Functions

 VuoMovieExporterParameters (int width=1024, int height=768, double time=0, double duration=10, double framerate=30, int spatialSupersample=1, int temporalSupersample=1, float shutterAngle=360, enum ImageFormat imageFormat=H264, double quality=1, bool watermark=false)
 Initializes movie exporter parameters.
 
void print (void)
 Prints a description of the parameters to STDOUT.
 
double getEstimatedBitrate (void)
 Returns the estimated average bitrate, in bits per second.
 
unsigned long getEstimatedSize (void)
 Returns the estimated file size, in bytes.
 

Static Public Member Functions

static bool isProResAvailable (void)
 Returns true if ProRes4444 and ProRes422 are available on this system.
 

Public Attributes

int width
 Frame width, in pixels.
 
int height
 Frame height, in pixels.
 
double time
 Starting time, in seconds.
 
double duration
 Duration, in seconds.
 
double framerate
 Frames per second.
 
int spatialSupersample
 Resolution multiplier.
 
int temporalSupersample
 Framerate multiplier.
 
float shutterAngle
 When using temporal supersampling, specifies the percentage of time the shutter is open (between 0 and 360).
 
enum ImageFormat imageFormat
 Image format.
 
double quality
 Image quality (between 0 and 1).
 
bool watermark
 Should a "Vuo Free Trial" watermark be overlaid on the output images?
 
std::map< std::string,
json_object * > 
inputs
 Input port names and values.
 

Member Enumeration Documentation

Movie export codecs.

Constructor & Destructor Documentation

VuoMovieExporterParameters::VuoMovieExporterParameters ( int  width = 1024,
int  height = 768,
double  time = 0,
double  duration = 10,
double  framerate = 30,
int  spatialSupersample = 1,
int  temporalSupersample = 1,
float  shutterAngle = 360,
enum ImageFormat  imageFormat = H264,
double  quality = 1,
bool  watermark = false 
)

Initializes movie exporter parameters.

Member Function Documentation

double VuoMovieExporterParameters::getEstimatedBitrate ( void  )

Returns the estimated average bitrate, in bits per second.

Only valid for H264.

unsigned long VuoMovieExporterParameters::getEstimatedSize ( void  )

Returns the estimated file size, in bytes.

Only valid for H264.

bool VuoMovieExporterParameters::isProResAvailable ( void  )
static

Returns true if ProRes4444 and ProRes422 are available on this system.

On Mac OS 10.9 and later, they're always available.

On Mac OS 10.8 and 10.7, they require Final Cut Pro to be installed.

void VuoMovieExporterParameters::print ( void  )

Prints a description of the parameters to STDOUT.

Member Data Documentation

double VuoMovieExporterParameters::duration

Duration, in seconds.

double VuoMovieExporterParameters::framerate

Frames per second.

int VuoMovieExporterParameters::height

Frame height, in pixels.

enum ImageFormat VuoMovieExporterParameters::imageFormat

Image format.

std::map<std::string, json_object *> VuoMovieExporterParameters::inputs

Input port names and values.

double VuoMovieExporterParameters::quality

Image quality (between 0 and 1).

float VuoMovieExporterParameters::shutterAngle

When using temporal supersampling, specifies the percentage of time the shutter is open (between 0 and 360).

int VuoMovieExporterParameters::spatialSupersample

Resolution multiplier.

int VuoMovieExporterParameters::temporalSupersample

Framerate multiplier.

double VuoMovieExporterParameters::time

Starting time, in seconds.

bool VuoMovieExporterParameters::watermark

Should a "Vuo Free Trial" watermark be overlaid on the output images?

int VuoMovieExporterParameters::width

Frame width, in pixels.


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