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

Description

Information about an Art-Net input device.

Classes

struct  VuoArtNetAddress
 A set of values that specifiy a DMX512 universe. More...
 
struct  VuoArtNetInputDevice
 Information about an Art-Net input device. More...
 

Functions

VuoArtNetInputDevice VuoArtNetInputDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoArtNetInputDevice_getJson (const VuoArtNetInputDevice value)
 Encodes value as a JSON object.
 
char * VuoArtNetInputDevice_getSummary (const VuoArtNetInputDevice value)
 Returns a compact string representation of value.
 
VuoArtNetInputDevice VuoArtNetInputDevice_make (const VuoInteger net, const VuoInteger subNet, const VuoInteger universe)
 Creates a new Art-Net device description from an address.
 
bool VuoArtNetInputDevice_areEqual (const VuoArtNetInputDevice value1, const VuoArtNetInputDevice value2)
 Returns true if the two input devices are equivalent:
 
bool VuoArtNetInputDevice_isLessThan (const VuoArtNetInputDevice value1, const VuoArtNetInputDevice value2)
 Returns true if value1 < value2.
 
bool VuoArtNetAddress_areEqual (const VuoArtNetAddress value1, const VuoArtNetAddress value2)
 Returns true if the two addresses are identical.
 
bool VuoArtNetAddress_isLessThan (const VuoArtNetAddress valueA, const VuoArtNetAddress valueB)
 Returns true if value1 < value2.
 
VuoArtNetInputDevice VuoArtNetInputDevice_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoArtNetInputDevice_getString (const VuoArtNetInputDevice value)
 Automatically generated function.
 
void VuoArtNetInputDevice_retain (VuoArtNetInputDevice value)
 Automatically generated function.
 
void VuoArtNetInputDevice_release (VuoArtNetInputDevice value)
 Automatically generated function.
 

Class Documentation

struct VuoArtNetAddress
Class Members
VuoInteger net
VuoInteger subNet
VuoInteger universe
struct VuoArtNetInputDevice
Class Members
VuoArtNetAddress address
VuoText ethernetAddress
VuoText ipAddress
VuoText name

Function Documentation

bool VuoArtNetAddress_areEqual ( const VuoArtNetAddress  value1,
const VuoArtNetAddress  value2 
)

Returns true if the two addresses are identical.

bool VuoArtNetAddress_isLessThan ( const VuoArtNetAddress  valueA,
const VuoArtNetAddress  valueB 
)

Returns true if value1 < value2.

bool VuoArtNetInputDevice_areEqual ( const VuoArtNetInputDevice  value1,
const VuoArtNetInputDevice  value2 
)

Returns true if the two input devices are equivalent:

  • The addresses (Net/Sub-Net/Universe) must match
  • The sending mode (broadcast vs. unicast) must match, and if unicast is used, the IP address must match
  • The name and ethernetAddress must match
struct json_object* VuoArtNetInputDevice_getJson ( const VuoArtNetInputDevice  value)
read

Encodes value as a JSON object.

char* VuoArtNetInputDevice_getString ( const VuoArtNetInputDevice  value)

Automatically generated function.

char* VuoArtNetInputDevice_getSummary ( const VuoArtNetInputDevice  value)

Returns a compact string representation of value.

bool VuoArtNetInputDevice_isLessThan ( const VuoArtNetInputDevice  value1,
const VuoArtNetInputDevice  value2 
)

Returns true if value1 < value2.

VuoArtNetInputDevice VuoArtNetInputDevice_make ( const VuoInteger  net,
const VuoInteger  subNet,
const VuoInteger  universe 
)

Creates a new Art-Net device description from an address.

VuoArtNetInputDevice VuoArtNetInputDevice_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"name": "",
"ipAddress": "",
"ethernetAddress": "",
"net": 0,
"subNet": 0,
"universe": 0,
}
VuoArtNetInputDevice VuoArtNetInputDevice_makeFromString ( const char *  str)

Automatically generated function.

void VuoArtNetInputDevice_release ( VuoArtNetInputDevice  value)

Automatically generated function.

void VuoArtNetInputDevice_retain ( VuoArtNetInputDevice  value)

Automatically generated function.