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

Description

A list of VuoVideoFrame elements.

Classes

struct  VuoList_VuoVideoFrame_struct
 A list of VuoVideoFrame elements. More...
 

Typedefs

typedef struct
VuoList_VuoVideoFrame_struct
VuoList_VuoVideoFrame
 A list of VuoVideoFrame elements.
 

Functions

VuoList_VuoVideoFrame VuoListCreate_VuoVideoFrame (void)
 Creates a new list of VuoVideoFrame elements.
 
VuoList_VuoVideoFrame VuoListCreateWithCount_VuoVideoFrame (const unsigned long count, const VuoVideoFrame value)
 Creates a new list of count instances of value.
 
VuoList_VuoVideoFrame VuoListCopy_VuoVideoFrame (const VuoList_VuoVideoFrame list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoVideoFrame VuoListGetValue_VuoVideoFrame (const VuoList_VuoVideoFrame list, const unsigned long index)
 Returns the VuoVideoFrame at index.
 
VuoVideoFrameVuoListGetData_VuoVideoFrame (const VuoList_VuoVideoFrame list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoVideoFrame (const VuoList_VuoVideoFrame list, const VuoVideoFrame value, const unsigned long index)
 Changes the VuoVideoFrame at index.
 
void VuoListInsertValue_VuoVideoFrame (const VuoList_VuoVideoFrame list, const VuoVideoFrame value, const unsigned long index)
 Inserts the VuoVideoFrame immediately before index.
 
void VuoListPrependValue_VuoVideoFrame (VuoList_VuoVideoFrame list, const VuoVideoFrame value)
 Prepends value to list.
 
void VuoListAppendValue_VuoVideoFrame (VuoList_VuoVideoFrame list, const VuoVideoFrame value)
 Appends value to list.
 
void VuoListExchangeValues_VuoVideoFrame (VuoList_VuoVideoFrame list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoVideoFrame (VuoList_VuoVideoFrame list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoVideoFrame (VuoList_VuoVideoFrame list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoVideoFrame (VuoList_VuoVideoFrame 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_VuoVideoFrame (VuoList_VuoVideoFrame list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoVideoFrame (VuoList_VuoVideoFrame list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoVideoFrame (VuoList_VuoVideoFrame list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoVideoFrame (VuoList_VuoVideoFrame list, const unsigned long index)
 Removes the VuoVideoFrame at index.
 
unsigned long VuoListGetCount_VuoVideoFrame (const VuoList_VuoVideoFrame list)
 Returns the number of elements in list.
 
VuoList_VuoVideoFrame VuoList_VuoVideoFrame_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoVideoFrame_getJson (const VuoList_VuoVideoFrame value)
 Encodes value as a JSON object.
 
char * VuoList_VuoVideoFrame_getSummary (const VuoList_VuoVideoFrame value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoVideoFrame VuoList_VuoVideoFrame_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoVideoFrame_getString (const VuoList_VuoVideoFrame value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoVideoFrame_struct
Class Members
void * l

Typedef Documentation

A list of VuoVideoFrame elements.

Function Documentation

struct json_object* VuoList_VuoVideoFrame_getJson ( const VuoList_VuoVideoFrame  value)
read

Encodes value as a JSON object.

char* VuoList_VuoVideoFrame_getString ( const VuoList_VuoVideoFrame  value)

Automatically generated function.

char* VuoList_VuoVideoFrame_getSummary ( const VuoList_VuoVideoFrame  value)

Produces a brief human-readable summary of value.

VuoList_VuoVideoFrame VuoList_VuoVideoFrame_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoVideoFrame ( VuoList_VuoVideoFrame  list,
const VuoVideoFrame  value 
)

Appends value to list.

VuoList_VuoVideoFrame VuoListCopy_VuoVideoFrame ( const VuoList_VuoVideoFrame  list)

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

VuoList_VuoVideoFrame VuoListCreate_VuoVideoFrame ( void  )

Creates a new list of VuoVideoFrame elements.

VuoList_VuoVideoFrame VuoListCreateWithCount_VuoVideoFrame ( const unsigned long  count,
const VuoVideoFrame  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoVideoFrame ( VuoList_VuoVideoFrame  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_VuoVideoFrame ( VuoList_VuoVideoFrame  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoVideoFrame ( const VuoList_VuoVideoFrame  list)

Returns the number of elements in list.

VuoVideoFrame* VuoListGetData_VuoVideoFrame ( const VuoList_VuoVideoFrame  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.

VuoVideoFrame VuoListGetValue_VuoVideoFrame ( const VuoList_VuoVideoFrame  list,
const unsigned long  index 
)

Returns the VuoVideoFrame 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_VuoVideoFrame ( const VuoList_VuoVideoFrame  list,
const VuoVideoFrame  value,
const unsigned long  index 
)

Inserts the VuoVideoFrame 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_VuoVideoFrame ( VuoList_VuoVideoFrame  list,
const VuoVideoFrame  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoVideoFrame ( VuoList_VuoVideoFrame  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoVideoFrame ( VuoList_VuoVideoFrame  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoVideoFrame ( VuoList_VuoVideoFrame  list)

Removes the last value from list.

void VuoListRemoveValue_VuoVideoFrame ( VuoList_VuoVideoFrame  list,
const unsigned long  index 
)

Removes the VuoVideoFrame 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_VuoVideoFrame ( VuoList_VuoVideoFrame  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoVideoFrame ( const VuoList_VuoVideoFrame  list,
const VuoVideoFrame  value,
const unsigned long  index 
)

Changes the VuoVideoFrame 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_VuoVideoFrame ( VuoList_VuoVideoFrame  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.