Vuo  2.0.2
Classes | Macros | Functions
VuoVideoFrame

Description

An image and timestamp for a single frame of video.

Classes

struct  VuoVideoFrame
 An image and timestamp for a single frame of video. More...
 

Macros

#define VuoVideoFrame_NoTimestamp   -INFINITY
 VuoVideoFrame.timestamp's value when no timestamp is available. More...
 
#define VuoVideoFrame_SUPPORTS_COMPARISON
 This type has _areEqual() and _isLessThan() functions. More...
 

Functions

VuoVideoFrame VuoVideoFrame_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoVideoFrame_getJson (const VuoVideoFrame value)
 Encodes value as a JSON object. More...
 
char * VuoVideoFrame_getSummary (const VuoVideoFrame value)
 Returns a compact string representation of value. More...
 
bool VuoVideoFrame_areEqual (VuoVideoFrame value1, VuoVideoFrame value2)
 Returns true if the frames are identical. More...
 
bool VuoVideoFrame_isLessThan (const VuoVideoFrame a, const VuoVideoFrame b)
 Returns true if a < b. More...
 
static VuoVideoFrame VuoVideoFrame_make (VuoImage image, VuoReal timestamp, VuoReal duration) __attribute__((const))
 Returns a VuoVideoFrame with image and timestamp. More...
 
VuoVideoFrame VuoVideoFrame_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoVideoFrame_getString (const VuoVideoFrame value)
 Automatically generated function. More...
 
void VuoVideoFrame_retain (VuoVideoFrame value)
 Automatically generated function. More...
 
void VuoVideoFrame_release (VuoVideoFrame value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoVideoFrame

struct VuoVideoFrame
Class Members
char blah[42]
VuoReal duration
VuoImage image
VuoReal timestamp

Macro Definition Documentation

◆ VuoVideoFrame_NoTimestamp

#define VuoVideoFrame_NoTimestamp   -INFINITY

VuoVideoFrame.timestamp's value when no timestamp is available.

Definition at line 25 of file VuoVideoFrame.h.

◆ VuoVideoFrame_SUPPORTS_COMPARISON

#define VuoVideoFrame_SUPPORTS_COMPARISON

This type has _areEqual() and _isLessThan() functions.

Definition at line 46 of file VuoVideoFrame.h.

Function Documentation

◆ VuoVideoFrame_areEqual()

bool VuoVideoFrame_areEqual ( VuoVideoFrame  value1,
VuoVideoFrame  value2 
)

Returns true if the frames are identical.

Definition at line 97 of file VuoVideoFrame.c.

◆ VuoVideoFrame_getJson()

struct json_object* VuoVideoFrame_getJson ( const VuoVideoFrame  value)

Encodes value as a JSON object.

Definition at line 73 of file VuoVideoFrame.c.

◆ VuoVideoFrame_getString()

char* VuoVideoFrame_getString ( const VuoVideoFrame  value)

Automatically generated function.

◆ VuoVideoFrame_getSummary()

char* VuoVideoFrame_getSummary ( const VuoVideoFrame  value)

Returns a compact string representation of value.

Definition at line 89 of file VuoVideoFrame.c.

◆ VuoVideoFrame_isLessThan()

bool VuoVideoFrame_isLessThan ( const VuoVideoFrame  a,
const VuoVideoFrame  b 
)

Returns true if a < b.

Changed in Vuo 2.0.0:
New.

Definition at line 109 of file VuoVideoFrame.c.

◆ VuoVideoFrame_make()

static VuoVideoFrame VuoVideoFrame_make ( VuoImage  image,
VuoReal  timestamp,
VuoReal  duration 
) const
inlinestatic

Returns a VuoVideoFrame with image and timestamp.

Definition at line 64 of file VuoVideoFrame.h.

◆ VuoVideoFrame_makeFromJson()

VuoVideoFrame VuoVideoFrame_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"image" : NULL,
"timestamp" : 0.0
"duration" : 0.0
}

Definition at line 39 of file VuoVideoFrame.c.

◆ VuoVideoFrame_makeFromString()

VuoVideoFrame VuoVideoFrame_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoVideoFrame_release()

void VuoVideoFrame_release ( VuoVideoFrame  value)

Automatically generated function.

◆ VuoVideoFrame_retain()

void VuoVideoFrame_retain ( VuoVideoFrame  value)

Automatically generated function.