Vuo
1.2.1
|
A list of VuoSyphonServerDescription elements.
Classes | |
struct | VuoList_VuoSyphonServerDescription_struct |
A list of VuoSyphonServerDescription elements. More... | |
Typedefs | |
typedef struct VuoList_VuoSyphonServerDescription_struct * | VuoList_VuoSyphonServerDescription |
A list of VuoSyphonServerDescription elements. | |
A list of VuoSyphonServerDescription elements.
|
read |
Encodes value
as a JSON object.
char* VuoList_VuoSyphonServerDescription_getString | ( | const VuoList_VuoSyphonServerDescription | value | ) |
Automatically generated function.
char* VuoList_VuoSyphonServerDescription_getSummary | ( | const VuoList_VuoSyphonServerDescription | value | ) |
Produces a brief human-readable summary of value
.
VuoList_VuoSyphonServerDescription VuoList_VuoSyphonServerDescription_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoList_VuoSyphonServerDescription VuoList_VuoSyphonServerDescription_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value | ||
) |
Appends value
to list
.
VuoList_VuoSyphonServerDescription VuoListCopy_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
VuoList_VuoSyphonServerDescription VuoListCreate_VuoSyphonServerDescription | ( | void | ) |
Creates a new list of VuoSyphonServerDescription elements.
VuoList_VuoSyphonServerDescription VuoListCreateWithCount_VuoSyphonServerDescription | ( | const unsigned long | count, |
const VuoSyphonServerDescription | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoSyphonServerDescription to quickly initialize a large list.
void VuoListCut_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | 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_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
unsigned long VuoListGetCount_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list | ) |
Returns the number of elements in list
.
VuoSyphonServerDescription* VuoListGetData_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | 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.
VuoSyphonServerDescription VuoListGetValue_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
const unsigned long | index | ||
) |
Returns the VuoSyphonServerDescription 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_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoSyphonServerDescription
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_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value | ||
) |
Prepends value
to list
.
void VuoListRemoveAll_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Removes all values from list
.
void VuoListRemoveFirstValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Removes the first value from list
.
void VuoListRemoveLastValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Removes the last value from list
.
void VuoListRemoveValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const unsigned long | index | ||
) |
Removes the VuoSyphonServerDescription
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_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Reverses the order of the items in list
.
void VuoListSetValue_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value, | ||
const unsigned long | index | ||
) |
Changes the VuoSyphonServerDescription 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_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | 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.