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

Description

A list of VuoAudioBins elements.

Classes

struct  VuoList_VuoAudioBins_struct
 A list of VuoAudioBins elements. More...
 

Typedefs

typedef struct
VuoList_VuoAudioBins_struct
VuoList_VuoAudioBins
 A list of VuoAudioBins elements.
 

Functions

VuoList_VuoAudioBins VuoListCreate_VuoAudioBins (void)
 Creates a new list of VuoAudioBins elements.
 
VuoList_VuoAudioBins VuoListCreateWithCount_VuoAudioBins (const unsigned long count, const VuoAudioBins value)
 Creates a new list of count instances of value.
 
VuoList_VuoAudioBins VuoListCopy_VuoAudioBins (const VuoList_VuoAudioBins list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoAudioBins VuoListGetValue_VuoAudioBins (const VuoList_VuoAudioBins list, const unsigned long index)
 Returns the VuoAudioBins at index.
 
VuoAudioBinsVuoListGetData_VuoAudioBins (const VuoList_VuoAudioBins list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoAudioBins (const VuoList_VuoAudioBins list, const VuoAudioBins value, const unsigned long index)
 Changes the VuoAudioBins at index.
 
void VuoListInsertValue_VuoAudioBins (const VuoList_VuoAudioBins list, const VuoAudioBins value, const unsigned long index)
 Inserts the VuoAudioBins immediately before index.
 
void VuoListPrependValue_VuoAudioBins (VuoList_VuoAudioBins list, const VuoAudioBins value)
 Prepends value to list.
 
void VuoListAppendValue_VuoAudioBins (VuoList_VuoAudioBins list, const VuoAudioBins value)
 Appends value to list.
 
void VuoListExchangeValues_VuoAudioBins (VuoList_VuoAudioBins list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoAudioBins (VuoList_VuoAudioBins list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoAudioBins (VuoList_VuoAudioBins list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoAudioBins (VuoList_VuoAudioBins 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_VuoAudioBins (VuoList_VuoAudioBins list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoAudioBins (VuoList_VuoAudioBins list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoAudioBins (VuoList_VuoAudioBins list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoAudioBins (VuoList_VuoAudioBins list, const unsigned long index)
 Removes the VuoAudioBins at index.
 
unsigned long VuoListGetCount_VuoAudioBins (const VuoList_VuoAudioBins list)
 Returns the number of elements in list.
 
VuoList_VuoAudioBins VuoList_VuoAudioBins_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoAudioBins_getJson (const VuoList_VuoAudioBins value)
 Encodes value as a JSON object.
 
char * VuoList_VuoAudioBins_getSummary (const VuoList_VuoAudioBins value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoAudioBins VuoList_VuoAudioBins_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoAudioBins_getString (const VuoList_VuoAudioBins value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoAudioBins_struct
Class Members
void * l

Typedef Documentation

A list of VuoAudioBins elements.

Function Documentation

struct json_object* VuoList_VuoAudioBins_getJson ( const VuoList_VuoAudioBins  value)
read

Encodes value as a JSON object.

char* VuoList_VuoAudioBins_getString ( const VuoList_VuoAudioBins  value)

Automatically generated function.

char* VuoList_VuoAudioBins_getSummary ( const VuoList_VuoAudioBins  value)

Produces a brief human-readable summary of value.

VuoList_VuoAudioBins VuoList_VuoAudioBins_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoAudioBins ( VuoList_VuoAudioBins  list,
const VuoAudioBins  value 
)

Appends value to list.

VuoList_VuoAudioBins VuoListCopy_VuoAudioBins ( const VuoList_VuoAudioBins  list)

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

VuoList_VuoAudioBins VuoListCreate_VuoAudioBins ( void  )

Creates a new list of VuoAudioBins elements.

VuoList_VuoAudioBins VuoListCreateWithCount_VuoAudioBins ( const unsigned long  count,
const VuoAudioBins  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoAudioBins ( VuoList_VuoAudioBins  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_VuoAudioBins ( VuoList_VuoAudioBins  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoAudioBins ( const VuoList_VuoAudioBins  list)

Returns the number of elements in list.

VuoAudioBins* VuoListGetData_VuoAudioBins ( const VuoList_VuoAudioBins  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.

VuoAudioBins VuoListGetValue_VuoAudioBins ( const VuoList_VuoAudioBins  list,
const unsigned long  index 
)

Returns the VuoAudioBins 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_VuoAudioBins ( const VuoList_VuoAudioBins  list,
const VuoAudioBins  value,
const unsigned long  index 
)

Inserts the VuoAudioBins 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_VuoAudioBins ( VuoList_VuoAudioBins  list,
const VuoAudioBins  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoAudioBins ( VuoList_VuoAudioBins  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoAudioBins ( VuoList_VuoAudioBins  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoAudioBins ( VuoList_VuoAudioBins  list)

Removes the last value from list.

void VuoListRemoveValue_VuoAudioBins ( VuoList_VuoAudioBins  list,
const unsigned long  index 
)

Removes the VuoAudioBins 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_VuoAudioBins ( VuoList_VuoAudioBins  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoAudioBins ( const VuoList_VuoAudioBins  list,
const VuoAudioBins  value,
const unsigned long  index 
)

Changes the VuoAudioBins 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_VuoAudioBins ( VuoList_VuoAudioBins  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.