Vuo  1.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoAudioEncoding

Description

A list of VuoAudioEncoding elements.

Classes

struct  VuoList_VuoAudioEncoding_struct
 A list of VuoAudioEncoding elements. More...
 

Typedefs

typedef struct
VuoList_VuoAudioEncoding_struct
VuoList_VuoAudioEncoding
 A list of VuoAudioEncoding elements.
 

Functions

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

Class Documentation

struct VuoList_VuoAudioEncoding_struct
Class Members
void * l

Typedef Documentation

A list of VuoAudioEncoding elements.

Function Documentation

struct json_object* VuoList_VuoAudioEncoding_getJson ( const VuoList_VuoAudioEncoding  value)
read

Encodes value as a JSON object.

char* VuoList_VuoAudioEncoding_getString ( const VuoList_VuoAudioEncoding  value)

Automatically generated function.

char* VuoList_VuoAudioEncoding_getSummary ( const VuoList_VuoAudioEncoding  value)

Produces a brief human-readable summary of value.

VuoList_VuoAudioEncoding VuoList_VuoAudioEncoding_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoAudioEncoding VuoList_VuoAudioEncoding_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const VuoAudioEncoding  value 
)

Appends value to list.

VuoList_VuoAudioEncoding VuoListCopy_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list)

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

VuoList_VuoAudioEncoding VuoListCreate_VuoAudioEncoding ( void  )

Creates a new list of VuoAudioEncoding elements.

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.

void VuoListCut_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Removes items from the list except those in the range specified by startIndex and itemCount.

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

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoAudioEncoding ( const VuoList_VuoAudioEncoding  list)

Returns the number of elements in list.

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.

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).

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.

void VuoListPrependValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list,
const VuoAudioEncoding  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Removes the last value from list.

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.

void VuoListReverse_VuoAudioEncoding ( VuoList_VuoAudioEncoding  list)

Reverses the order of the items in list.

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

Changes the VuoAudioEncoding at index.

Index values start at 1. 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).

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.