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.
#define	VuoVideoFrame_SUPPORTS_COMPARISON
	Instances of this type can be compared and sorted.

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

---

Class Documentation

VuoVideoFrame

struct VuoVideoFrame

Class Members
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 29 of file VuoVideoFrame.h.

VuoVideoFrame_SUPPORTS_COMPARISON

#define VuoVideoFrame_SUPPORTS_COMPARISON

Instances of this type can be compared and sorted.

Definition at line 42 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 95 of file VuoVideoFrame.c.

VuoVideoFrame_getJson()

struct json_object * VuoVideoFrame_getJson

(

const VuoVideoFrame

value

)

Encodes value as a JSON object.

Definition at line 71 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 87 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 107 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 38 of file VuoVideoFrame.c.

VuoVideoFrame_release()

void VuoVideoFrame_release

(

VuoVideoFrame

value

)

Automatically generated function.

VuoVideoFrame_retain()

void VuoVideoFrame_retain

(

VuoVideoFrame

value

)

Automatically generated function.