Vuo  2.3.2
Classes | Macros | Functions
VuoArtNetOutputDevice

Description

Information about an Art-Net output device.

Classes

struct  VuoArtNetOutputDevice
 Information about an Art-Net output device. More...
 

Functions

VuoArtNetOutputDevice VuoArtNetOutputDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoArtNetOutputDevice_getJson (const VuoArtNetOutputDevice value)
 Encodes value as a JSON object. More...
 
char * VuoArtNetOutputDevice_getSummary (const VuoArtNetOutputDevice value)
 Returns a compact string representation of value. More...
 
VuoArtNetOutputDevice VuoArtNetOutputDevice_makeBroadcast (const VuoInteger net, const VuoInteger subNet, const VuoInteger universe)
 Creates a new Art-Net device description, for broadcasting. More...
 
VuoArtNetOutputDevice VuoArtNetOutputDevice_makeUnicast (const VuoText ipAddress, const VuoInteger net, const VuoInteger subNet, const VuoInteger universe)
 Creates a new Art-Net device description, for sending to a single IP. More...
 
bool VuoArtNetOutputDevice_areEqual (const VuoArtNetOutputDevice value1, const VuoArtNetOutputDevice value2)
 Returns true if the two output devices are equivalent: More...
 
bool VuoArtNetOutputDevice_isLessThan (const VuoArtNetOutputDevice value1, const VuoArtNetOutputDevice value2)
 Returns true if value1 < value2. More...
 
VuoArtNetOutputDevice VuoArtNetOutputDevice_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoArtNetOutputDevice_getString (const VuoArtNetOutputDevice value)
 Automatically generated function. More...
 
void VuoArtNetOutputDevice_retain (VuoArtNetOutputDevice value)
 Automatically generated function. More...
 
void VuoArtNetOutputDevice_release (VuoArtNetOutputDevice value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoArtNetOutputDevice

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

Function Documentation

◆ VuoArtNetOutputDevice_areEqual()

bool VuoArtNetOutputDevice_areEqual ( const VuoArtNetOutputDevice  value1,
const VuoArtNetOutputDevice  value2 
)

Returns true if the two output 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 133 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_getJson()

struct json_object* VuoArtNetOutputDevice_getJson ( const VuoArtNetOutputDevice  value)

Encodes value as a JSON object.

Definition at line 59 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_getString()

char* VuoArtNetOutputDevice_getString ( const VuoArtNetOutputDevice  value)

Automatically generated function.

◆ VuoArtNetOutputDevice_getSummary()

char* VuoArtNetOutputDevice_getSummary ( const VuoArtNetOutputDevice  value)

Returns a compact string representation of value.

Definition at line 84 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_isLessThan()

bool VuoArtNetOutputDevice_isLessThan ( const VuoArtNetOutputDevice  value1,
const VuoArtNetOutputDevice  value2 
)

Returns true if value1 < value2.

Definition at line 153 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_makeBroadcast()

VuoArtNetOutputDevice VuoArtNetOutputDevice_makeBroadcast ( const VuoInteger  net,
const VuoInteger  subNet,
const VuoInteger  universe 
)

Creates a new Art-Net device description, for broadcasting.

Definition at line 102 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_makeFromJson()

VuoArtNetOutputDevice VuoArtNetOutputDevice_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 43 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_makeFromString()

VuoArtNetOutputDevice VuoArtNetOutputDevice_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoArtNetOutputDevice_makeUnicast()

VuoArtNetOutputDevice VuoArtNetOutputDevice_makeUnicast ( const VuoText  ipAddress,
const VuoInteger  net,
const VuoInteger  subNet,
const VuoInteger  universe 
)

Creates a new Art-Net device description, for sending to a single IP.

Definition at line 115 of file VuoArtNetOutputDevice.c.

◆ VuoArtNetOutputDevice_release()

void VuoArtNetOutputDevice_release ( VuoArtNetOutputDevice  value)

Automatically generated function.

◆ VuoArtNetOutputDevice_retain()

void VuoArtNetOutputDevice_retain ( VuoArtNetOutputDevice  value)

Automatically generated function.