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. More...

void	print (void)
	Prints a description of the parameters to STDOUT. More...

double	getEstimatedBitrate (void)
	Returns the estimated average bitrate, in bits per second. More...

unsigned long	getEstimatedSize (void)
	Returns the estimated file size, in bytes. More...

Static Public Member Functions
static bool	isProResAvailable (void)
	Returns true if ProRes4444 and ProRes422 are available on this system. More...

Public Attributes
int	width
	Frame width, in pixels. More...

int	height
	Frame height, in pixels. More...

double	time
	Starting time, in seconds. More...

double	duration
	Duration, in seconds. More...

double	framerate
	Frames per second. More...

int	spatialSupersample
	Resolution multiplier. More...

int	temporalSupersample
	Framerate multiplier. More...

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

enum ImageFormat	imageFormat
	Image format. More...

double	quality
	Image quality (between 0 and 1). More...

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

std::map< std::string, json_object * >	inputs
	Input port names and values. More...

Member Enumeration Documentation

◆ ImageFormat

enum VuoMovieExporterParameters::ImageFormat

Movie export codecs.

Constructor & Destructor Documentation

◆ VuoMovieExporterParameters()

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

◆ getEstimatedBitrate()

double VuoMovieExporterParameters::getEstimatedBitrate ( void )

Returns the estimated average bitrate, in bits per second.

Only valid for H264.

◆ getEstimatedSize()

unsigned long VuoMovieExporterParameters::getEstimatedSize ( void )

Returns the estimated file size, in bytes.

Only valid for H264.

◆ isProResAvailable()

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.

◆ print()

void VuoMovieExporterParameters::print ( void )

Prints a description of the parameters to STDOUT.

Member Data Documentation

◆ duration

double VuoMovieExporterParameters::duration

Duration, in seconds.

◆ framerate

double VuoMovieExporterParameters::framerate

Frames per second.

◆ height

int VuoMovieExporterParameters::height

Frame height, in pixels.

◆ imageFormat

enum ImageFormat VuoMovieExporterParameters::imageFormat

Image format.

◆ inputs

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

Input port names and values.

◆ quality

double VuoMovieExporterParameters::quality

Image quality (between 0 and 1).

◆ shutterAngle

float VuoMovieExporterParameters::shutterAngle

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

◆ spatialSupersample

int VuoMovieExporterParameters::spatialSupersample

Resolution multiplier.

◆ temporalSupersample

int VuoMovieExporterParameters::temporalSupersample

Framerate multiplier.

◆ time

double VuoMovieExporterParameters::time

Starting time, in seconds.

◆ watermark

bool VuoMovieExporterParameters::watermark

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

◆ width

int VuoMovieExporterParameters::width

Frame width, in pixels.

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

base/VuoMovieExporter.hh
base/VuoMovieExporter.mm