Vuo  2.3.2
Classes | Macros | Functions
VuoAudioInputDevice

Description

Information about an audio input device.

Classes

struct  VuoAudioInputDevice
 Information about an audio input device. More...
 

Functions

VuoAudioInputDevice VuoAudioInputDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoAudioInputDevice_getJson (const VuoAudioInputDevice value)
 Encodes value as a JSON object. More...
 
char * VuoAudioInputDevice_getSummary (const VuoAudioInputDevice value)
 Returns a compact string representation of value. More...
 
char * VuoAudioInputDevice_getShortSummary (const VuoAudioInputDevice value)
 Returns a compact string representation of value. More...
 
bool VuoAudioInputDevice_areEqual (VuoAudioInputDevice value1, VuoAudioInputDevice value2)
 Returns true if the two audio input device specifications are identical. More...
 
bool VuoAudioInputDevice_isLessThan (const VuoAudioInputDevice a, const VuoAudioInputDevice b)
 Returns true if the id of a is less than the id of b. More...
 
static VuoAudioInputDevice VuoAudioInputDevice_make (VuoInteger id, VuoText modelUid, VuoText name, VuoInteger channelCount) __attribute__((const))
 Returns an audio input device with the specified values. More...
 
VuoAudioInputDevice VuoAudioInputDevice_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoAudioInputDevice_getString (const VuoAudioInputDevice value)
 Automatically generated function. More...
 
void VuoAudioInputDevice_retain (VuoAudioInputDevice value)
 Automatically generated function. More...
 
void VuoAudioInputDevice_release (VuoAudioInputDevice value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoAudioInputDevice

struct VuoAudioInputDevice
Class Members
VuoInteger channelCount The number of input 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

◆ VuoAudioInputDevice_areEqual()

bool VuoAudioInputDevice_areEqual ( VuoAudioInputDevice  value1,
VuoAudioInputDevice  value2 
)

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

Definition at line 150 of file VuoAudioInputDevice.c.

◆ VuoAudioInputDevice_getJson()

struct json_object* VuoAudioInputDevice_getJson ( const VuoAudioInputDevice  value)

Encodes value as a JSON object.

Definition at line 52 of file VuoAudioInputDevice.c.

◆ VuoAudioInputDevice_getShortSummary()

char* VuoAudioInputDevice_getShortSummary ( const VuoAudioInputDevice  value)

Returns a compact string representation of value.

Definition at line 118 of file VuoAudioInputDevice.c.

◆ VuoAudioInputDevice_getString()

char* VuoAudioInputDevice_getString ( const VuoAudioInputDevice  value)

Automatically generated function.

◆ VuoAudioInputDevice_getSummary()

char* VuoAudioInputDevice_getSummary ( const VuoAudioInputDevice  value)

Returns a compact string representation of value.

Definition at line 86 of file VuoAudioInputDevice.c.

◆ VuoAudioInputDevice_isLessThan()

bool VuoAudioInputDevice_isLessThan ( const VuoAudioInputDevice  a,
const VuoAudioInputDevice  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 VuoAudioInputDevice.c.

◆ VuoAudioInputDevice_make()

static VuoAudioInputDevice VuoAudioInputDevice_make ( VuoInteger  id,
VuoText  modelUid,
VuoText  name,
VuoInteger  channelCount 
) const
inlinestatic

Returns an audio input device with the specified values.

Definition at line 58 of file VuoAudioInputDevice.h.

◆ VuoAudioInputDevice_makeFromJson()

VuoAudioInputDevice VuoAudioInputDevice_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 VuoAudioInputDevice.c.

◆ VuoAudioInputDevice_makeFromString()

VuoAudioInputDevice VuoAudioInputDevice_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoAudioInputDevice_release()

void VuoAudioInputDevice_release ( VuoAudioInputDevice  value)

Automatically generated function.

◆ VuoAudioInputDevice_retain()

void VuoAudioInputDevice_retain ( VuoAudioInputDevice  value)

Automatically generated function.