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

Class Documentation

◆ VuoArtNetAddress

struct VuoArtNetAddress
Class Members
VuoInteger net
VuoInteger subNet
VuoInteger universe

◆ VuoArtNetInputDevice

struct VuoArtNetInputDevice
Class Members
VuoArtNetAddress address
VuoText ethernetAddress
VuoText ipAddress
VuoText name

Function Documentation

◆ VuoArtNetAddress_areEqual()

bool VuoArtNetAddress_areEqual ( const VuoArtNetAddress  value1,
const VuoArtNetAddress  value2 
)

Returns true if the two addresses are identical.

Definition at line 146 of file VuoArtNetInputDevice.c.

◆ VuoArtNetAddress_isLessThan()

bool VuoArtNetAddress_isLessThan ( const VuoArtNetAddress  valueA,
const VuoArtNetAddress  valueB 
)

Returns true if value1 < value2.

Definition at line 156 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_areEqual()

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

Definition at line 114 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_getJson()

struct json_object* VuoArtNetInputDevice_getJson ( const VuoArtNetInputDevice  value)

Encodes value as a JSON object.

Definition at line 58 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_getString()

char* VuoArtNetInputDevice_getString ( const VuoArtNetInputDevice  value)

Automatically generated function.

◆ VuoArtNetInputDevice_getSummary()

char* VuoArtNetInputDevice_getSummary ( const VuoArtNetInputDevice  value)

Returns a compact string representation of value.

Definition at line 83 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_isLessThan()

bool VuoArtNetInputDevice_isLessThan ( const VuoArtNetInputDevice  value1,
const VuoArtNetInputDevice  value2 
)

Returns true if value1 < value2.

Definition at line 134 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_make()

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

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

Definition at line 97 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_makeFromJson()

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,
}

Definition at line 42 of file VuoArtNetInputDevice.c.

◆ VuoArtNetInputDevice_makeFromString()

VuoArtNetInputDevice VuoArtNetInputDevice_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoArtNetInputDevice_release()

void VuoArtNetInputDevice_release ( VuoArtNetInputDevice  value)

Automatically generated function.

◆ VuoArtNetInputDevice_retain()

void VuoArtNetInputDevice_retain ( VuoArtNetInputDevice  value)

Automatically generated function.