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.

#define	VuoAudioFrame_SUPPORTS_COMPARISON
	Instances of this type can be compared and sorted.

Functions
VuoAudioFrame	VuoAudioFrame_makeFromJson (struct json_object *js)
	Decodes the JSON object `js` to create a new value.

struct json_object *	VuoAudioFrame_getJson (const VuoAudioFrame value)
	Encodes `value` as a JSON object.

char *	VuoAudioFrame_getSummary (const VuoAudioFrame value)
	Returns a compact string representation of `value`.

bool	VuoAudioFrame_areEqual (VuoAudioFrame value1, VuoAudioFrame value2)
	Returns true if the frames have matching timestamps within a tolerance of 1 millisecond.

bool	VuoAudioFrame_isLessThan (const VuoAudioFrame a, const VuoAudioFrame b)
	Returns true if the timestamp of `a` is less than the timestamp of `b`.

void	VuoAudioFrame_retain (VuoAudioFrame value)
	`VuoCompilerType::parseOrGenerateRetainOrReleaseFunction` can't currently generate this on arm64.

void	VuoAudioFrame_release (VuoAudioFrame value)
	`VuoCompilerType::parseOrGenerateRetainOrReleaseFunction` can't currently generate this on arm64.

static VuoAudioFrame	VuoAudioFrame_make (VuoList_VuoAudioSamples channels, VuoReal timestamp) __attribute__((const))
	Returns a new VuoAudioFrame.

char *	VuoAudioFrame_getString (const VuoAudioFrame value)
	Automatically generated function.

Class Documentation

◆ VuoAudioFrame

struct VuoAudioFrame

Class Members
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 30 of file VuoAudioFrame.h.

◆ VuoAudioFrame_SUPPORTS_COMPARISON

#define VuoAudioFrame_SUPPORTS_COMPARISON

Instances of this type can be compared and sorted.

Definition at line 41 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 74 of file VuoAudioFrame.c.

◆ VuoAudioFrame_getJson()

struct json_object * VuoAudioFrame_getJson ( const VuoAudioFrame value )

Encodes value as a JSON object.

Definition at line 50 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 66 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 83 of file VuoAudioFrame.c.

◆ VuoAudioFrame_make()

static VuoAudioFrame VuoAudioFrame_make	(	VuoList_VuoAudioSamples	channels,
		VuoReal	timestamp
	)		const

inlinestatic

Returns a new VuoAudioFrame.

Definition at line 64 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_release()

void VuoAudioFrame_release ( VuoAudioFrame value )

VuoCompilerType::parseOrGenerateRetainOrReleaseFunction can't currently generate this on arm64.

https://b33p.net/kosada/vuo/vuo/-/issues/19142#note_2158967

Definition at line 101 of file VuoAudioFrame.c.

◆ VuoAudioFrame_retain()

void VuoAudioFrame_retain ( VuoAudioFrame value )