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

Description

A list of VuoMovieFormat elements.

Classes

struct  VuoList_VuoMovieFormat_struct
 A list of VuoMovieFormat elements. More...
 

Typedefs

typedef struct
VuoList_VuoMovieFormat_struct
VuoList_VuoMovieFormat
 A list of VuoMovieFormat elements.
 

Functions

VuoList_VuoMovieFormat VuoListCreate_VuoMovieFormat (void)
 Creates a new list of VuoMovieFormat elements.
 
VuoList_VuoMovieFormat VuoListCreateWithCount_VuoMovieFormat (const unsigned long count, const VuoMovieFormat value)
 Creates a new list of count instances of value.
 
VuoList_VuoMovieFormat VuoListCopy_VuoMovieFormat (const VuoList_VuoMovieFormat list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoMovieFormat VuoListGetValue_VuoMovieFormat (const VuoList_VuoMovieFormat list, const unsigned long index)
 Returns the VuoMovieFormat at index.
 
VuoMovieFormatVuoListGetData_VuoMovieFormat (const VuoList_VuoMovieFormat list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoMovieFormat (const VuoList_VuoMovieFormat list, const VuoMovieFormat value, const unsigned long index)
 Changes the VuoMovieFormat at index.
 
void VuoListInsertValue_VuoMovieFormat (const VuoList_VuoMovieFormat list, const VuoMovieFormat value, const unsigned long index)
 Inserts the VuoMovieFormat immediately before index.
 
void VuoListPrependValue_VuoMovieFormat (VuoList_VuoMovieFormat list, const VuoMovieFormat value)
 Prepends value to list.
 
void VuoListAppendValue_VuoMovieFormat (VuoList_VuoMovieFormat list, const VuoMovieFormat value)
 Appends value to list.
 
void VuoListExchangeValues_VuoMovieFormat (VuoList_VuoMovieFormat list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoMovieFormat (VuoList_VuoMovieFormat list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoMovieFormat (VuoList_VuoMovieFormat list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoMovieFormat (VuoList_VuoMovieFormat 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_VuoMovieFormat (VuoList_VuoMovieFormat list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoMovieFormat (VuoList_VuoMovieFormat list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoMovieFormat (VuoList_VuoMovieFormat list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoMovieFormat (VuoList_VuoMovieFormat list, const unsigned long index)
 Removes the VuoMovieFormat at index.
 
unsigned long VuoListGetCount_VuoMovieFormat (const VuoList_VuoMovieFormat list)
 Returns the number of elements in list.
 
VuoList_VuoMovieFormat VuoList_VuoMovieFormat_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoMovieFormat_getJson (const VuoList_VuoMovieFormat value)
 Encodes value as a JSON object.
 
char * VuoList_VuoMovieFormat_getSummary (const VuoList_VuoMovieFormat value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoMovieFormat VuoList_VuoMovieFormat_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoMovieFormat_getString (const VuoList_VuoMovieFormat value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoMovieFormat_struct
Class Members
void * l

Typedef Documentation

A list of VuoMovieFormat elements.

Function Documentation

struct json_object* VuoList_VuoMovieFormat_getJson ( const VuoList_VuoMovieFormat  value)
read

Encodes value as a JSON object.

char* VuoList_VuoMovieFormat_getString ( const VuoList_VuoMovieFormat  value)

Automatically generated function.

char* VuoList_VuoMovieFormat_getSummary ( const VuoList_VuoMovieFormat  value)

Produces a brief human-readable summary of value.

VuoList_VuoMovieFormat VuoList_VuoMovieFormat_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoMovieFormat ( VuoList_VuoMovieFormat  list,
const VuoMovieFormat  value 
)

Appends value to list.

VuoList_VuoMovieFormat VuoListCopy_VuoMovieFormat ( const VuoList_VuoMovieFormat  list)

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

VuoList_VuoMovieFormat VuoListCreate_VuoMovieFormat ( void  )

Creates a new list of VuoMovieFormat elements.

VuoList_VuoMovieFormat VuoListCreateWithCount_VuoMovieFormat ( const unsigned long  count,
const VuoMovieFormat  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoMovieFormat ( VuoList_VuoMovieFormat  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_VuoMovieFormat ( VuoList_VuoMovieFormat  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoMovieFormat ( const VuoList_VuoMovieFormat  list)

Returns the number of elements in list.

VuoMovieFormat* VuoListGetData_VuoMovieFormat ( const VuoList_VuoMovieFormat  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.

VuoMovieFormat VuoListGetValue_VuoMovieFormat ( const VuoList_VuoMovieFormat  list,
const unsigned long  index 
)

Returns the VuoMovieFormat 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_VuoMovieFormat ( const VuoList_VuoMovieFormat  list,
const VuoMovieFormat  value,
const unsigned long  index 
)

Inserts the VuoMovieFormat 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_VuoMovieFormat ( VuoList_VuoMovieFormat  list,
const VuoMovieFormat  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoMovieFormat ( VuoList_VuoMovieFormat  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoMovieFormat ( VuoList_VuoMovieFormat  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoMovieFormat ( VuoList_VuoMovieFormat  list)

Removes the last value from list.

void VuoListRemoveValue_VuoMovieFormat ( VuoList_VuoMovieFormat  list,
const unsigned long  index 
)

Removes the VuoMovieFormat 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_VuoMovieFormat ( VuoList_VuoMovieFormat  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoMovieFormat ( const VuoList_VuoMovieFormat  list,
const VuoMovieFormat  value,
const unsigned long  index 
)

Changes the VuoMovieFormat 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_VuoMovieFormat ( VuoList_VuoMovieFormat  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.