VuoAudioSamples

Description

A set of audio amplitudes for a single channel.

Classes
struct	VuoAudioSamples
	A set of audio amplitudes for a single channel. More...

Functions
VuoAudioSamples	VuoAudioSamples_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value. More...
struct json_object *	VuoAudioSamples_getJson (const VuoAudioSamples value)
	Encodes value as a JSON object. More...
char *	VuoAudioSamples_getSummary (const VuoAudioSamples value)
	Returns a compact string representation of value. More...
VuoAudioSamples	VuoAudioSamples_alloc (VuoInteger sampleCount)
	Allocates and registers the samples array. More...
bool	VuoAudioSamples_isEmpty (const VuoAudioSamples samples)
bool	VuoAudioSamples_isPopulated (const VuoAudioSamples samples)

Variables
const VuoInteger	VuoAudioSamples_bufferSize
	https://b33p.net/kosada/node/7650 More...
const VuoReal	VuoAudioSamples_sampleRate
	https://b33p.net/kosada/node/7649 More...
VuoAudioSamples	VuoAudioSamples_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoAudioSamples_getString (const VuoAudioSamples value)
	Automatically generated function. More...
void	VuoAudioSamples_retain (VuoAudioSamples value)
	Automatically generated function. More...
void	VuoAudioSamples_release (VuoAudioSamples value)
	Automatically generated function. More...

---

Class Documentation

VuoAudioSamples

struct VuoAudioSamples

Class Members
VuoInteger	sampleCount	The number of elements in samples.
VuoReal *	samples	Samples should typically be between -1 and 1, centered at 0.
VuoReal	samplesPerSecond	The sample rate. E.g., 48000.

Function Documentation

VuoAudioSamples_alloc()

VuoAudioSamples VuoAudioSamples_alloc

(

VuoInteger

sampleCount

)

Allocates and registers the samples array.

Definition at line 99 of file VuoAudioSamples.c.

VuoAudioSamples_getJson()

struct json_object* VuoAudioSamples_getJson

(

const VuoAudioSamples

value

)

Encodes value as a JSON object.

Definition at line 73 of file VuoAudioSamples.c.

VuoAudioSamples_getString()

char* VuoAudioSamples_getString

(

const VuoAudioSamples

value

)

Automatically generated function.

VuoAudioSamples_getSummary()

char* VuoAudioSamples_getSummary

(

const VuoAudioSamples

value

)

Returns a compact string representation of value.

Definition at line 91 of file VuoAudioSamples.c.

VuoAudioSamples_isEmpty()

bool VuoAudioSamples_isEmpty

(

const VuoAudioSamples

samples

)

• If there are no audio samples, returns true.
• If all audio samples have amplitude 0, returns true.
• Otherwise returns false.

Definition at line 116 of file VuoAudioSamples.c.

VuoAudioSamples_isPopulated()

bool VuoAudioSamples_isPopulated

(

const VuoAudioSamples

samples

)

• If there are no audio samples, returns false.
• Otherwise returns true.

Definition at line 132 of file VuoAudioSamples.c.

VuoAudioSamples_makeFromJson()

VuoAudioSamples VuoAudioSamples_makeFromJson

(

json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

{
  "samples" : [ -0.014525, 0.015363, 0.013679 ],
  "samplesPerSecond" : 44100.000000
}

Definition at line 42 of file VuoAudioSamples.c.

VuoAudioSamples_makeFromString()

VuoAudioSamples VuoAudioSamples_makeFromString

(

const char *

str

)

Automatically generated function.

VuoAudioSamples_release()

void VuoAudioSamples_release

(

VuoAudioSamples

value

)

Automatically generated function.

VuoAudioSamples_retain()

void VuoAudioSamples_retain

(

VuoAudioSamples

value

)

Automatically generated function.

Variable Documentation

VuoAudioSamples_bufferSize

const VuoInteger VuoAudioSamples_bufferSize

extern

https://b33p.net/kosada/node/7650

Definition at line 29 of file VuoAudioSamples.c.

VuoAudioSamples_sampleRate

const VuoReal VuoAudioSamples_sampleRate

extern

https://b33p.net/kosada/node/7649

Definition at line 30 of file VuoAudioSamples.c.