Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoAudioSamples

Description

A list of VuoAudioSamples elements.

Classes

struct  VuoList_VuoAudioSamples_struct
 A list of VuoAudioSamples elements. More...
 

Typedefs

typedef const struct VuoList_VuoAudioSamples_structVuoList_VuoAudioSamples
 A list of VuoAudioSamples elements. More...
 

Functions

VuoList_VuoAudioSamples VuoListCreate_VuoAudioSamples (void)
 Creates a new list of VuoAudioSamples elements. More...
 
VuoList_VuoAudioSamples VuoListCreateWithCount_VuoAudioSamples (const unsigned long count, const VuoAudioSamples value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoAudioSamples VuoListCopy_VuoAudioSamples (const VuoList_VuoAudioSamples list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoAudioSamples VuoListGetValue_VuoAudioSamples (const VuoList_VuoAudioSamples list, const unsigned long index)
 Returns the VuoAudioSamples at index. More...
 
VuoAudioSamplesVuoListGetData_VuoAudioSamples (const VuoList_VuoAudioSamples list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoAudioSamples (const VuoList_VuoAudioSamples list, bool(^function)(const VuoAudioSamples value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoAudioSamples (const VuoList_VuoAudioSamples list, const VuoAudioSamples value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoAudioSamples at index. More...
 
void VuoListInsertValue_VuoAudioSamples (const VuoList_VuoAudioSamples list, const VuoAudioSamples value, const unsigned long index)
 Inserts the VuoAudioSamples immediately before index. More...
 
void VuoListPrependValue_VuoAudioSamples (VuoList_VuoAudioSamples list, const VuoAudioSamples value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoAudioSamples (VuoList_VuoAudioSamples list, const VuoAudioSamples value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoAudioSamples (VuoList_VuoAudioSamples list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoAudioSamples (VuoList_VuoAudioSamples list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoAudioSamples (VuoList_VuoAudioSamples list)
 Reverses the order of the items in list. More...
 
VuoList_VuoAudioSamples VuoListSubset_VuoAudioSamples (VuoList_VuoAudioSamples 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. More...
 
void VuoListRemoveFirstValue_VuoAudioSamples (VuoList_VuoAudioSamples list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoAudioSamples (VuoList_VuoAudioSamples list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoAudioSamples (VuoList_VuoAudioSamples list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoAudioSamples (VuoList_VuoAudioSamples list, const unsigned long index)
 Removes the VuoAudioSamples at index. More...
 
unsigned long VuoListGetCount_VuoAudioSamples (const VuoList_VuoAudioSamples list)
 Returns the number of elements in list. More...
 
VuoList_VuoAudioSamples VuoList_VuoAudioSamples_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoAudioSamples_getJson (const VuoList_VuoAudioSamples value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoAudioSamples_getSummary (const VuoList_VuoAudioSamples value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoAudioSamples VuoList_VuoAudioSamples_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoAudioSamples_getString (const VuoList_VuoAudioSamples value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoAudioSamples_struct

struct VuoList_VuoAudioSamples_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoAudioSamples

A list of VuoAudioSamples elements.

Function Documentation

◆ VuoList_VuoAudioSamples_getJson()

struct json_object* VuoList_VuoAudioSamples_getJson ( const VuoList_VuoAudioSamples  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoAudioSamples.cc.

◆ VuoList_VuoAudioSamples_getString()

char* VuoList_VuoAudioSamples_getString ( const VuoList_VuoAudioSamples  value)

Automatically generated function.

◆ VuoList_VuoAudioSamples_getSummary()

char* VuoList_VuoAudioSamples_getSummary ( const VuoList_VuoAudioSamples  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoAudioSamples.cc.

◆ VuoList_VuoAudioSamples_makeFromJson()

VuoList_VuoAudioSamples VuoList_VuoAudioSamples_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]

Definition at line 63 of file VuoList_VuoAudioSamples.cc.

◆ VuoList_VuoAudioSamples_makeFromString()

VuoList_VuoAudioSamples VuoList_VuoAudioSamples_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoAudioSamples()

void VuoListAppendValue_VuoAudioSamples ( VuoList_VuoAudioSamples  list,
const VuoAudioSamples  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoAudioSamples.cc.

◆ VuoListCopy_VuoAudioSamples()

VuoList_VuoAudioSamples VuoListCopy_VuoAudioSamples ( const VuoList_VuoAudioSamples  list)

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

Definition at line 174 of file VuoList_VuoAudioSamples.cc.

◆ VuoListCreate_VuoAudioSamples()

VuoList_VuoAudioSamples VuoListCreate_VuoAudioSamples ( void  )

Creates a new list of VuoAudioSamples elements.

Definition at line 154 of file VuoList_VuoAudioSamples.cc.

◆ VuoListCreateWithCount_VuoAudioSamples()

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.

Definition at line 161 of file VuoList_VuoAudioSamples.cc.

◆ VuoListExchangeValues_VuoAudioSamples()

void VuoListExchangeValues_VuoAudioSamples ( VuoList_VuoAudioSamples  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

Definition at line 318 of file VuoList_VuoAudioSamples.cc.

◆ VuoListForeach_VuoAudioSamples()

void VuoListForeach_VuoAudioSamples ( const VuoList_VuoAudioSamples  list,
bool(^)(const VuoAudioSamples value)  function 
)

Applies function to each of list's items, serially in order of index.

If function returns false, visiting will stop immediately (possibly before all items have been visited).

Changed in Vuo 2.0.0:
New.

Definition at line 229 of file VuoList_VuoAudioSamples.cc.

◆ VuoListGetCount_VuoAudioSamples()

unsigned long VuoListGetCount_VuoAudioSamples ( const VuoList_VuoAudioSamples  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoAudioSamples.cc.

◆ VuoListGetData_VuoAudioSamples()

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.

Definition at line 219 of file VuoList_VuoAudioSamples.cc.

◆ VuoListGetValue_VuoAudioSamples()

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

If iterating over an entire list, consider using VuoListGetData_VuoAudioSamples or VuoListForeach_VuoAudioSamples.

Definition at line 203 of file VuoList_VuoAudioSamples.cc.

◆ VuoListInsertValue_VuoAudioSamples()

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.

Definition at line 276 of file VuoList_VuoAudioSamples.cc.

◆ VuoListPrependValue_VuoAudioSamples()

void VuoListPrependValue_VuoAudioSamples ( VuoList_VuoAudioSamples  list,
const VuoAudioSamples  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoAudioSamples.cc.

◆ VuoListRemoveAll_VuoAudioSamples()

void VuoListRemoveAll_VuoAudioSamples ( VuoList_VuoAudioSamples  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoAudioSamples.cc.

◆ VuoListRemoveFirstValue_VuoAudioSamples()

void VuoListRemoveFirstValue_VuoAudioSamples ( VuoList_VuoAudioSamples  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoAudioSamples.cc.

◆ VuoListRemoveLastValue_VuoAudioSamples()

void VuoListRemoveLastValue_VuoAudioSamples ( VuoList_VuoAudioSamples  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoAudioSamples.cc.

◆ VuoListRemoveValue_VuoAudioSamples()

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.

Definition at line 536 of file VuoList_VuoAudioSamples.cc.

◆ VuoListReverse_VuoAudioSamples()

void VuoListReverse_VuoAudioSamples ( VuoList_VuoAudioSamples  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoAudioSamples.cc.

◆ VuoListSetValue_VuoAudioSamples()

void VuoListSetValue_VuoAudioSamples ( const VuoList_VuoAudioSamples  list,
const VuoAudioSamples  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoAudioSamples 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.

Definition at line 241 of file VuoList_VuoAudioSamples.cc.

◆ VuoListShuffle_VuoAudioSamples()

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.

Definition at line 401 of file VuoList_VuoAudioSamples.cc.

◆ VuoListSubset_VuoAudioSamples()

VuoList_VuoAudioSamples VuoListSubset_VuoAudioSamples ( VuoList_VuoAudioSamples  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.

Definition at line 431 of file VuoList_VuoAudioSamples.cc.