Vuo  2.0.0
Classes | Macros | Functions
VuoAudioFrame

Description

A list of VuoAudioSamples (per-channel) and timestamp for one frame of audio. of video.

Classes

struct  VuoAudioFrame
 A list of VuoAudioSamples (per-channel) and timestamp for one frame of audio. More...
 

Macros

#define VuoAudioFrame_NoTimestamp   -INFINITY
 VuoAudioFrame.timestamp's value when no timestamp is available. More...
 
#define VuoAudioFrame_SUPPORTS_COMPARISON
 This type has _areEqual() and _isLessThan() functions. More...
 

Functions

VuoAudioFrame VuoAudioFrame_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoAudioFrame_getJson (const VuoAudioFrame value)
 Encodes value as a JSON object. More...
 
char * VuoAudioFrame_getSummary (const VuoAudioFrame value)
 Returns a compact string representation of value. More...
 
bool VuoAudioFrame_areEqual (VuoAudioFrame value1, VuoAudioFrame value2)
 Returns true if the frames have matching timestamps within a tolerance of 1 millisecond. More...
 
bool VuoAudioFrame_isLessThan (const VuoAudioFrame a, const VuoAudioFrame b)
 Returns true if the timestamp of a is less than the timestamp of b. More...
 
static VuoAudioFrame VuoAudioFrame_make (VuoList_VuoAudioSamples channels, VuoReal timestamp) __attribute__((const))
 Returns a new VuoAudioFrame. More...
 
VuoAudioFrame VuoAudioFrame_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoAudioFrame_getString (const VuoAudioFrame value)
 Automatically generated function. More...
 
void VuoAudioFrame_retain (VuoAudioFrame value)
 Automatically generated function. More...
 
void VuoAudioFrame_release (VuoAudioFrame value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoAudioFrame

struct VuoAudioFrame
Class Members
char blah[42]
VuoList_VuoAudioSamples channels
VuoReal timestamp

Macro Definition Documentation

◆ VuoAudioFrame_NoTimestamp

#define VuoAudioFrame_NoTimestamp   -INFINITY

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

Definition at line 26 of file VuoAudioFrame.h.

◆ VuoAudioFrame_SUPPORTS_COMPARISON

#define VuoAudioFrame_SUPPORTS_COMPARISON

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

Definition at line 45 of file VuoAudioFrame.h.

Function Documentation

◆ VuoAudioFrame_areEqual()

bool VuoAudioFrame_areEqual ( VuoAudioFrame  value1,
VuoAudioFrame  value2 
)

Returns true if the frames have matching timestamps within a tolerance of 1 millisecond.

Definition at line 75 of file VuoAudioFrame.c.

◆ VuoAudioFrame_getJson()

struct json_object* VuoAudioFrame_getJson ( const VuoAudioFrame  value)

Encodes value as a JSON object.

Definition at line 51 of file VuoAudioFrame.c.

◆ VuoAudioFrame_getString()

char* VuoAudioFrame_getString ( const VuoAudioFrame  value)

Automatically generated function.

◆ VuoAudioFrame_getSummary()

char* VuoAudioFrame_getSummary ( const VuoAudioFrame  value)

Returns a compact string representation of value.

Definition at line 67 of file VuoAudioFrame.c.

◆ VuoAudioFrame_isLessThan()

bool VuoAudioFrame_isLessThan ( const VuoAudioFrame  a,
const VuoAudioFrame  b 
)

Returns true if the timestamp of a is less than the timestamp of b.

Changed in Vuo 2.0.0:
New.

Definition at line 85 of file VuoAudioFrame.c.

◆ VuoAudioFrame_make()

static VuoAudioFrame VuoAudioFrame_make ( VuoList_VuoAudioSamples  channels,
VuoReal  timestamp 
) const
inlinestatic

Returns a new VuoAudioFrame.

Definition at line 63 of file VuoAudioFrame.h.

◆ VuoAudioFrame_makeFromJson()

VuoAudioFrame VuoAudioFrame_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"samples" : NULL,
"timestamp" : 0.0
}

Definition at line 39 of file VuoAudioFrame.c.

◆ VuoAudioFrame_makeFromString()

VuoAudioFrame VuoAudioFrame_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoAudioFrame_release()

void VuoAudioFrame_release ( VuoAudioFrame  value)

Automatically generated function.

◆ VuoAudioFrame_retain()

void VuoAudioFrame_retain ( VuoAudioFrame  value)

Automatically generated function.