Vuo  2.3.2
Classes | Macros | Functions
VuoMovieFormat

Description

Describes the attributes of a movie file.

Classes

struct  VuoMovieFormat
 Describes the attributes of a movie file. More...
 

Functions

VuoMovieFormat VuoMovieFormat_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoMovieFormat_getJson (const VuoMovieFormat value)
 Encodes value as a JSON object. More...
 
char * VuoMovieFormat_getSummary (const VuoMovieFormat value)
 Returns a compact string representation of value. More...
 
bool VuoMovieFormat_areEqual (VuoMovieFormat value1, VuoMovieFormat value2)
 Returns true if the two movie format specifications are identical. More...
 
bool VuoMovieFormat_isLessThan (const VuoMovieFormat a, const VuoMovieFormat b)
 Returns true if a < b. More...
 
static VuoMovieFormat VuoMovieFormat_make (VuoMovieImageEncoding imgEncoding, VuoReal imgQuality, VuoAudioEncoding audEncoding, VuoReal audQuality) __attribute__((const))
 Returns a new VuoMovieFormat with specified attributes. More...
 
VuoMovieFormat VuoMovieFormat_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoMovieFormat_getString (const VuoMovieFormat value)
 Automatically generated function. More...
 
void VuoMovieFormat_retain (VuoMovieFormat value)
 Automatically generated function. More...
 
void VuoMovieFormat_release (VuoMovieFormat value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoMovieFormat

struct VuoMovieFormat
Class Members
VuoAudioEncoding audioEncoding Audio encoding format.
VuoReal audioQuality Audio quality. 1 is best, 0 is worst.
VuoMovieImageEncoding imageEncoding Image encoding format. JPEG, H.264, ProRes, etc.
VuoReal imageQuality Image quality. 1 is best, 0 is worst.

Function Documentation

◆ VuoMovieFormat_areEqual()

bool VuoMovieFormat_areEqual ( VuoMovieFormat  value1,
VuoMovieFormat  value2 
)

Returns true if the two movie format specifications are identical.

Definition at line 89 of file VuoMovieFormat.c.

◆ VuoMovieFormat_getJson()

struct json_object* VuoMovieFormat_getJson ( const VuoMovieFormat  value)

Encodes value as a JSON object.

Definition at line 55 of file VuoMovieFormat.c.

◆ VuoMovieFormat_getString()

char* VuoMovieFormat_getString ( const VuoMovieFormat  value)

Automatically generated function.

◆ VuoMovieFormat_getSummary()

char* VuoMovieFormat_getSummary ( const VuoMovieFormat  value)

Returns a compact string representation of value.

Definition at line 77 of file VuoMovieFormat.c.

◆ VuoMovieFormat_isLessThan()

bool VuoMovieFormat_isLessThan ( const VuoMovieFormat  a,
const VuoMovieFormat  b 
)

Returns true if a < b.

Changed in Vuo 2.0.0:
New.

Definition at line 102 of file VuoMovieFormat.c.

◆ VuoMovieFormat_make()

static VuoMovieFormat VuoMovieFormat_make ( VuoMovieImageEncoding  imgEncoding,
VuoReal  imgQuality,
VuoAudioEncoding  audEncoding,
VuoReal  audQuality 
) const
inlinestatic

Returns a new VuoMovieFormat with specified attributes.

Definition at line 61 of file VuoMovieFormat.h.

◆ VuoMovieFormat_makeFromJson()

VuoMovieFormat VuoMovieFormat_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"imageEncoding" : "",
"imageQuality" : ""
"audioEncoding" : ""
"audioQuality" : ""
}

Definition at line 42 of file VuoMovieFormat.c.

◆ VuoMovieFormat_makeFromString()

VuoMovieFormat VuoMovieFormat_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoMovieFormat_release()

void VuoMovieFormat_release ( VuoMovieFormat  value)

Automatically generated function.

◆ VuoMovieFormat_retain()

void VuoMovieFormat_retain ( VuoMovieFormat  value)

Automatically generated function.