Vuo
1.2.6
|
A list of VuoAudioFrame elements.
Classes | |
struct | VuoList_VuoAudioFrame_struct |
A list of VuoAudioFrame elements. More... | |
Typedefs | |
typedef struct VuoList_VuoAudioFrame_struct * | VuoList_VuoAudioFrame |
A list of VuoAudioFrame elements. | |
Functions | |
VuoList_VuoAudioFrame | VuoListCreate_VuoAudioFrame (void) |
Creates a new list of VuoAudioFrame elements. | |
VuoList_VuoAudioFrame | VuoListCreateWithCount_VuoAudioFrame (const unsigned long count, const VuoAudioFrame value) |
Creates a new list of count instances of value . | |
VuoList_VuoAudioFrame | VuoListCopy_VuoAudioFrame (const VuoList_VuoAudioFrame list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. | |
VuoAudioFrame | VuoListGetValue_VuoAudioFrame (const VuoList_VuoAudioFrame list, const unsigned long index) |
Returns the VuoAudioFrame at index . | |
VuoAudioFrame * | VuoListGetData_VuoAudioFrame (const VuoList_VuoAudioFrame list) |
Returns a pointer to a C array containing the list items. | |
void | VuoListSetValue_VuoAudioFrame (const VuoList_VuoAudioFrame list, const VuoAudioFrame value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoAudioFrame at index . | |
void | VuoListInsertValue_VuoAudioFrame (const VuoList_VuoAudioFrame list, const VuoAudioFrame value, const unsigned long index) |
Inserts the VuoAudioFrame immediately before index . | |
void | VuoListPrependValue_VuoAudioFrame (VuoList_VuoAudioFrame list, const VuoAudioFrame value) |
Prepends value to list . | |
void | VuoListAppendValue_VuoAudioFrame (VuoList_VuoAudioFrame list, const VuoAudioFrame value) |
Appends value to list . | |
void | VuoListExchangeValues_VuoAudioFrame (VuoList_VuoAudioFrame list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . | |
void | VuoListShuffle_VuoAudioFrame (VuoList_VuoAudioFrame list, const double chaos) |
Generates a random permutation of list . | |
void | VuoListReverse_VuoAudioFrame (VuoList_VuoAudioFrame list) |
Reverses the order of the items in list . | |
VuoList_VuoAudioFrame | VuoListSubset_VuoAudioFrame (VuoList_VuoAudioFrame 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 . | |
void | VuoListRemoveFirstValue_VuoAudioFrame (VuoList_VuoAudioFrame list) |
Removes the first value from list . | |
void | VuoListRemoveLastValue_VuoAudioFrame (VuoList_VuoAudioFrame list) |
Removes the last value from list . | |
void | VuoListRemoveAll_VuoAudioFrame (VuoList_VuoAudioFrame list) |
Removes all values from list . | |
void | VuoListRemoveValue_VuoAudioFrame (VuoList_VuoAudioFrame list, const unsigned long index) |
Removes the VuoAudioFrame at index . | |
unsigned long | VuoListGetCount_VuoAudioFrame (const VuoList_VuoAudioFrame list) |
Returns the number of elements in list . | |
VuoList_VuoAudioFrame | VuoList_VuoAudioFrame_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoList_VuoAudioFrame_getJson (const VuoList_VuoAudioFrame value) |
Encodes value as a JSON object. | |
char * | VuoList_VuoAudioFrame_getSummary (const VuoList_VuoAudioFrame value) |
Produces a brief human-readable summary of value . | |
VuoList_VuoAudioFrame | VuoList_VuoAudioFrame_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoList_VuoAudioFrame_getString (const VuoList_VuoAudioFrame value) |
Automatically generated function. | |
typedef struct VuoList_VuoAudioFrame_struct * VuoList_VuoAudioFrame |
A list of VuoAudioFrame elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoAudioFrame_getString | ( | const VuoList_VuoAudioFrame | value | ) |
Automatically generated function.
char* VuoList_VuoAudioFrame_getSummary | ( | const VuoList_VuoAudioFrame | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoAudioFrame VuoList_VuoAudioFrame_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoAudioFrame VuoList_VuoAudioFrame_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list, |
const VuoAudioFrame | value | ||
) |
Appends value
to list
.
VuoList_VuoAudioFrame VuoListCopy_VuoAudioFrame | ( | const VuoList_VuoAudioFrame | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoAudioFrame VuoListCreate_VuoAudioFrame | ( | void | ) |
Creates a new list of VuoAudioFrame elements.
VuoList_VuoAudioFrame VuoListCreateWithCount_VuoAudioFrame | ( | const unsigned long | count, |
const VuoAudioFrame | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoAudioFrame to quickly initialize a large list.
void VuoListExchangeValues_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoAudioFrame | ( | const VuoList_VuoAudioFrame | list | ) |
Returns the number of elements in list
.
VuoAudioFrame* VuoListGetData_VuoAudioFrame | ( | const VuoList_VuoAudioFrame | 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.
VuoAudioFrame VuoListGetValue_VuoAudioFrame | ( | const VuoList_VuoAudioFrame | list, |
const unsigned long | index | ||
) |
Returns the VuoAudioFrame 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_VuoAudioFrame | ( | const VuoList_VuoAudioFrame | list, |
const VuoAudioFrame | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoAudioFrame
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_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list, |
const VuoAudioFrame | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list, |
const unsigned long | index | ||
) |
Removes the VuoAudioFrame
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_VuoAudioFrame | ( | VuoList_VuoAudioFrame | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoAudioFrame | ( | const VuoList_VuoAudioFrame | list, |
const VuoAudioFrame | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoAudioFrame 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
.
void VuoListShuffle_VuoAudioFrame | ( | VuoList_VuoAudioFrame | 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.
VuoList_VuoAudioFrame VuoListSubset_VuoAudioFrame | ( | VuoList_VuoAudioFrame | 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.