Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoAudioEncoding

Description

A list of VuoAudioEncoding elements.

Classes

struct  VuoList_VuoAudioEncoding_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoAudioEncoding_structVuoList_VuoAudioEncoding
 A list of VuoAudioEncoding elements. More...
 

Functions

VuoList_VuoAudioEncoding VuoListCreate_VuoAudioEncoding (void)
 Creates a new list of VuoAudioEncoding elements. More...
 
VuoList_VuoAudioEncoding VuoListCreateWithCount_VuoAudioEncoding (const unsigned long count, const VuoAudioEncoding value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoAudioEncoding VuoListCopy_VuoAudioEncoding (const VuoList_VuoAudioEncoding list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoAudioEncoding VuoListGetValue_VuoAudioEncoding (const VuoList_VuoAudioEncoding list, const unsigned long index)
 Returns the VuoAudioEncoding at index. More...
 
VuoAudioEncodingVuoListGetData_VuoAudioEncoding (const VuoList_VuoAudioEncoding list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoAudioEncoding (const VuoList_VuoAudioEncoding list, bool(^function)(const VuoAudioEncoding value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoAudioEncoding (const VuoList_VuoAudioEncoding list, const VuoAudioEncoding value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoAudioEncoding at index. More...
 
void VuoListInsertValue_VuoAudioEncoding (const VuoList_VuoAudioEncoding list, const VuoAudioEncoding value, const unsigned long index)
 Inserts the VuoAudioEncoding immediately before index. More...
 
void VuoListPrependValue_VuoAudioEncoding (VuoList_VuoAudioEncoding list, const VuoAudioEncoding value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoAudioEncoding (VuoList_VuoAudioEncoding list, const VuoAudioEncoding value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoAudioEncoding (VuoList_VuoAudioEncoding list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoAudioEncoding (VuoList_VuoAudioEncoding list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoAudioEncoding (VuoList_VuoAudioEncoding list)
 Reverses the order of the items in list. More...
 
VuoList_VuoAudioEncoding VuoListSubset_VuoAudioEncoding (VuoList_VuoAudioEncoding list, const signed long startIndex, const unsigned long itemCount)
 Returns a new list containing items from the original list in the range specified by startIndex and itemCount. More...
 
void VuoListRemoveFirstValue_VuoAudioEncoding (VuoList_VuoAudioEncoding list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoAudioEncoding (VuoList_VuoAudioEncoding list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoAudioEncoding (VuoList_VuoAudioEncoding list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoAudioEncoding (VuoList_VuoAudioEncoding list, const unsigned long index)
 Removes the VuoAudioEncoding at index. More...
 
unsigned long VuoListGetCount_VuoAudioEncoding (const VuoList_VuoAudioEncoding list)
 Returns the number of elements in list. More...
 
VuoList_VuoAudioEncoding VuoList_VuoAudioEncoding_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoAudioEncoding_getJson (const VuoList_VuoAudioEncoding value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoAudioEncoding_getSummary (const VuoList_VuoAudioEncoding value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoAudioEncoding VuoList_VuoAudioEncoding_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoAudioEncoding_getString (const VuoList_VuoAudioEncoding value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoAudioEncoding_struct

struct VuoList_VuoAudioEncoding_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoAudioEncoding

A list of VuoAudioEncoding elements.

Function Documentation

◆ VuoList_VuoAudioEncoding_getJson()

struct json_object* VuoList_VuoAudioEncoding_getJson ( const VuoList_VuoAudioEncoding  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoAudioEncoding.cc.

◆ VuoList_VuoAudioEncoding_getString()

char* VuoList_VuoAudioEncoding_getString ( const VuoList_VuoAudioEncoding  value)

Automatically generated function.

◆ VuoList_VuoAudioEncoding_getSummary()

char* VuoList_VuoAudioEncoding_getSummary ( const VuoList_VuoAudioEncoding  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoAudioEncoding.cc.

◆ VuoList_VuoAudioEncoding_makeFromJson()

VuoList_VuoAudioEncoding VuoList_VuoAudioEncoding_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]

Definition at line 63 of file VuoList_VuoAudioEncoding.cc.

◆ VuoList_VuoAudioEncoding_makeFromString()

VuoList_VuoAudioEncoding VuoList_VuoAudioEncoding_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoAudioEncoding()

void VuoListAppendValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const VuoAudioEncoding  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListCopy_VuoAudioEncoding()

VuoList_VuoAudioEncoding VuoListCopy_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

Definition at line 174 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListCreate_VuoAudioEncoding()

VuoList_VuoAudioEncoding VuoListCreate_VuoAudioEncoding ( void  )

Creates a new list of VuoAudioEncoding elements.

Definition at line 154 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListCreateWithCount_VuoAudioEncoding()

VuoList_VuoAudioEncoding VuoListCreateWithCount_VuoAudioEncoding ( const unsigned long  count,
const VuoAudioEncoding  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoAudioEncoding to quickly initialize a large list.

Definition at line 161 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListExchangeValues_VuoAudioEncoding()

void VuoListExchangeValues_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

Definition at line 318 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListForeach_VuoAudioEncoding()

void VuoListForeach_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list,
bool(^)(const VuoAudioEncoding value)  function 
)

Applies function to each of list's items, serially in order of index.

If function returns false, visiting will stop immediately (possibly before all items have been visited).

Changed in Vuo 2.0.0:
New.

Definition at line 229 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListGetCount_VuoAudioEncoding()

unsigned long VuoListGetCount_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListGetData_VuoAudioEncoding()

VuoAudioEncoding* VuoListGetData_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list)

Returns a pointer to a C array containing the list items.

Use this if you need a fast way to get or change multiple list items.

You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.

The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.

If the list has no items, returns NULL.

The pointer remains owned by the list; don't free it.

Definition at line 219 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListGetValue_VuoAudioEncoding()

VuoAudioEncoding VuoListGetValue_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list,
const unsigned long  index 
)

Returns the VuoAudioEncoding at index.

Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

If iterating over an entire list, consider using VuoListGetData_VuoAudioEncoding or VuoListForeach_VuoAudioEncoding.

Definition at line 203 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListInsertValue_VuoAudioEncoding()

void VuoListInsertValue_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list,
const VuoAudioEncoding  value,
const unsigned long  index 
)

Inserts the VuoAudioEncoding immediately before index.

Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.

Definition at line 276 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListPrependValue_VuoAudioEncoding()

void VuoListPrependValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const VuoAudioEncoding  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListRemoveAll_VuoAudioEncoding()

void VuoListRemoveAll_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListRemoveFirstValue_VuoAudioEncoding()

void VuoListRemoveFirstValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListRemoveLastValue_VuoAudioEncoding()

void VuoListRemoveLastValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListRemoveValue_VuoAudioEncoding()

void VuoListRemoveValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const unsigned long  index 
)

Removes the VuoAudioEncoding at index.

Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.

Definition at line 536 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListReverse_VuoAudioEncoding()

void VuoListReverse_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListSetValue_VuoAudioEncoding()

void VuoListSetValue_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list,
const VuoAudioEncoding  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoAudioEncoding at index.

Index values start at 1.

If expandListIfNeeded is false: If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

If expandListIfNeeded is true: If the list has less than index elements, it is expanded to accommodate the specified index. If index is 0, the list is resized to contain 1 item set to value.

Definition at line 241 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListShuffle_VuoAudioEncoding()

void VuoListShuffle_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const double  chaos 
)

Generates a random permutation of list.

chaos ranges from 0 to 1. When chaos is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.

Definition at line 401 of file VuoList_VuoAudioEncoding.cc.

◆ VuoListSubset_VuoAudioEncoding()

VuoList_VuoAudioEncoding VuoListSubset_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Returns a new list containing items from the original list in the range specified by startIndex and itemCount.

Items in the new list are retained (not copied) from the original list.

Definition at line 431 of file VuoList_VuoAudioEncoding.cc.