Vuo
1.2.0
|
A list of VuoAudioSamples elements.
Classes | |
struct | VuoList_VuoAudioSamples_struct |
A list of VuoAudioSamples elements. More... | |
Typedefs | |
typedef struct VuoList_VuoAudioSamples_struct * | VuoList_VuoAudioSamples |
A list of VuoAudioSamples elements. | |
Functions | |
VuoList_VuoAudioSamples | VuoListCreate_VuoAudioSamples (void) |
Creates a new list of VuoAudioSamples elements. | |
VuoList_VuoAudioSamples | VuoListCreateWithCount_VuoAudioSamples (const unsigned long count, const VuoAudioSamples value) |
Creates a new list of count instances of value . | |
VuoList_VuoAudioSamples | VuoListCopy_VuoAudioSamples (const VuoList_VuoAudioSamples list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. | |
VuoAudioSamples | VuoListGetValue_VuoAudioSamples (const VuoList_VuoAudioSamples list, const unsigned long index) |
Returns the VuoAudioSamples at index . | |
VuoAudioSamples * | VuoListGetData_VuoAudioSamples (const VuoList_VuoAudioSamples list) |
Returns a pointer to a C array containing the list items. | |
void | VuoListSetValue_VuoAudioSamples (const VuoList_VuoAudioSamples list, const VuoAudioSamples value, const unsigned long index) |
Changes the VuoAudioSamples at index . | |
void | VuoListInsertValue_VuoAudioSamples (const VuoList_VuoAudioSamples list, const VuoAudioSamples value, const unsigned long index) |
Inserts the VuoAudioSamples immediately before index . | |
void | VuoListPrependValue_VuoAudioSamples (VuoList_VuoAudioSamples list, const VuoAudioSamples value) |
Prepends value to list . | |
void | VuoListAppendValue_VuoAudioSamples (VuoList_VuoAudioSamples list, const VuoAudioSamples value) |
Appends value to list . | |
void | VuoListExchangeValues_VuoAudioSamples (VuoList_VuoAudioSamples list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . | |
void | VuoListShuffle_VuoAudioSamples (VuoList_VuoAudioSamples list, const double chaos) |
Generates a random permutation of list . | |
void | VuoListReverse_VuoAudioSamples (VuoList_VuoAudioSamples list) |
Reverses the order of the items in list . | |
void | VuoListCut_VuoAudioSamples (VuoList_VuoAudioSamples 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_VuoAudioSamples (VuoList_VuoAudioSamples list) |
Removes the first value from list . | |
void | VuoListRemoveLastValue_VuoAudioSamples (VuoList_VuoAudioSamples list) |
Removes the last value from list . | |
void | VuoListRemoveAll_VuoAudioSamples (VuoList_VuoAudioSamples list) |
Removes all values from list . | |
void | VuoListRemoveValue_VuoAudioSamples (VuoList_VuoAudioSamples list, const unsigned long index) |
Removes the VuoAudioSamples at index . | |
unsigned long | VuoListGetCount_VuoAudioSamples (const VuoList_VuoAudioSamples list) |
Returns the number of elements in list . | |
VuoList_VuoAudioSamples | VuoList_VuoAudioSamples_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoList_VuoAudioSamples_getJson (const VuoList_VuoAudioSamples value) |
Encodes value as a JSON object. | |
char * | VuoList_VuoAudioSamples_getSummary (const VuoList_VuoAudioSamples value) |
Produces a brief human-readable summary of value . | |
VuoList_VuoAudioSamples | VuoList_VuoAudioSamples_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoList_VuoAudioSamples_getString (const VuoList_VuoAudioSamples value) |
Automatically generated function. | |
typedef struct VuoList_VuoAudioSamples_struct * VuoList_VuoAudioSamples |
A list of VuoAudioSamples elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoAudioSamples_getString | ( | const VuoList_VuoAudioSamples | value | ) |
Automatically generated function.
char* VuoList_VuoAudioSamples_getSummary | ( | const VuoList_VuoAudioSamples | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoAudioSamples VuoList_VuoAudioSamples_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoAudioSamples VuoList_VuoAudioSamples_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list, |
const VuoAudioSamples | value | ||
) |
Appends value
to list
.
VuoList_VuoAudioSamples VuoListCopy_VuoAudioSamples | ( | const VuoList_VuoAudioSamples | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoAudioSamples VuoListCreate_VuoAudioSamples | ( | void | ) |
Creates a new list of VuoAudioSamples elements.
VuoList_VuoAudioSamples VuoListCreateWithCount_VuoAudioSamples | ( | const unsigned long | count, |
const VuoAudioSamples | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoAudioSamples to quickly initialize a large list.
void VuoListCut_VuoAudioSamples | ( | VuoList_VuoAudioSamples | 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_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoAudioSamples | ( | const VuoList_VuoAudioSamples | list | ) |
Returns the number of elements in list
.
VuoAudioSamples* VuoListGetData_VuoAudioSamples | ( | const VuoList_VuoAudioSamples | 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.
VuoAudioSamples VuoListGetValue_VuoAudioSamples | ( | const VuoList_VuoAudioSamples | list, |
const unsigned long | index | ||
) |
Returns the VuoAudioSamples 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_VuoAudioSamples | ( | const VuoList_VuoAudioSamples | list, |
const VuoAudioSamples | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoAudioSamples
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_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list, |
const VuoAudioSamples | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list, |
const unsigned long | index | ||
) |
Removes the VuoAudioSamples
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_VuoAudioSamples | ( | VuoList_VuoAudioSamples | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoAudioSamples | ( | const VuoList_VuoAudioSamples | list, |
const VuoAudioSamples | value, | ||
const unsigned long | index | ||
) |
Changes the VuoAudioSamples 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_VuoAudioSamples | ( | VuoList_VuoAudioSamples | 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.