Vuo  2.3.2
Classes | Macros | Functions
VuoAudioOutputDevice

Description

Information about an audio output device.

Classes

struct  VuoAudioOutputDevice
 Information about an audio ouput device. More...
 

Functions

VuoAudioOutputDevice VuoAudioOutputDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoAudioOutputDevice_getJson (const VuoAudioOutputDevice value)
 Encodes value as a JSON object. More...
 
char * VuoAudioOutputDevice_getSummary (const VuoAudioOutputDevice value)
 Returns a compact string representation of value. More...
 
char * VuoAudioOutputDevice_getShortSummary (const VuoAudioOutputDevice value)
 Returns a compact string representation of value. More...
 
bool VuoAudioOutputDevice_areEqual (VuoAudioOutputDevice value1, VuoAudioOutputDevice value2)
 Returns true if the two audio output device specifications are identical. More...
 
bool VuoAudioOutputDevice_isLessThan (const VuoAudioOutputDevice a, const VuoAudioOutputDevice b)
 Returns true if the id of a is less than the id of b. More...
 
static VuoAudioOutputDevice VuoAudioOutputDevice_make (VuoInteger id, VuoText modelUid, VuoText name, VuoInteger channelCount) __attribute__((const))
 Returns an audio output device with the specified values. More...
 
VuoAudioOutputDevice VuoAudioOutputDevice_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoAudioOutputDevice_getString (const VuoAudioOutputDevice value)
 Automatically generated function. More...
 
void VuoAudioOutputDevice_retain (VuoAudioOutputDevice value)
 Automatically generated function. More...
 
void VuoAudioOutputDevice_release (VuoAudioOutputDevice value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoAudioOutputDevice

struct VuoAudioOutputDevice
Class Members
VuoInteger channelCount The number of output channels on this device. <= 0 if unknown.
VuoInteger id If id is non-negative, use the specified device identifier.
VuoText modelUid If id is negative, use the first device whose modelUid contains modelUid.
VuoText name If id is negative and modelUid is empty, use the first device whose name matches name. This is a localized display name, so its value will differ depending on the currently-selected system language.

Function Documentation

◆ VuoAudioOutputDevice_areEqual()

bool VuoAudioOutputDevice_areEqual ( VuoAudioOutputDevice  value1,
VuoAudioOutputDevice  value2 
)

Returns true if the two audio output device specifications are identical.

Definition at line 150 of file VuoAudioOutputDevice.c.

◆ VuoAudioOutputDevice_getJson()

struct json_object* VuoAudioOutputDevice_getJson ( const VuoAudioOutputDevice  value)

Encodes value as a JSON object.

Definition at line 52 of file VuoAudioOutputDevice.c.

◆ VuoAudioOutputDevice_getShortSummary()

char* VuoAudioOutputDevice_getShortSummary ( const VuoAudioOutputDevice  value)

Returns a compact string representation of value.

Definition at line 118 of file VuoAudioOutputDevice.c.

◆ VuoAudioOutputDevice_getString()

char* VuoAudioOutputDevice_getString ( const VuoAudioOutputDevice  value)

Automatically generated function.

◆ VuoAudioOutputDevice_getSummary()

char* VuoAudioOutputDevice_getSummary ( const VuoAudioOutputDevice  value)

Returns a compact string representation of value.

Definition at line 86 of file VuoAudioOutputDevice.c.

◆ VuoAudioOutputDevice_isLessThan()

bool VuoAudioOutputDevice_isLessThan ( const VuoAudioOutputDevice  a,
const VuoAudioOutputDevice  b 
)

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

Changed in Vuo 2.0.0:
New.

Definition at line 162 of file VuoAudioOutputDevice.c.

◆ VuoAudioOutputDevice_make()

static VuoAudioOutputDevice VuoAudioOutputDevice_make ( VuoInteger  id,
VuoText  modelUid,
VuoText  name,
VuoInteger  channelCount 
) const
inlinestatic

Returns an audio output device with the specified values.

Definition at line 58 of file VuoAudioOutputDevice.h.

◆ VuoAudioOutputDevice_makeFromJson()

VuoAudioOutputDevice VuoAudioOutputDevice_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"id" : -1,
"modelUid" : "",
"name" : ""
}

Definition at line 39 of file VuoAudioOutputDevice.c.

◆ VuoAudioOutputDevice_makeFromString()

VuoAudioOutputDevice VuoAudioOutputDevice_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoAudioOutputDevice_release()

void VuoAudioOutputDevice_release ( VuoAudioOutputDevice  value)

Automatically generated function.

◆ VuoAudioOutputDevice_retain()

void VuoAudioOutputDevice_retain ( VuoAudioOutputDevice  value)

Automatically generated function.