Vuo  2.3.2
Classes | Macros | Functions
VuoNdiSource

Description

Information about an NDI device.

Classes

struct  VuoNdiSource
 Information about an NDI device. More...
 

Functions

VuoNdiSource VuoNdiSource_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoNdiSource_getJson (const VuoNdiSource value)
 Encodes value as a JSON object. More...
 
char * VuoNdiSource_getSummary (const VuoNdiSource value)
 Returns a compact string representation of value. More...
 
char * VuoNdiSource_getShortSummary (const VuoNdiSource value)
 Returns a compact string representation of value. More...
 
bool VuoNdiSource_areEqual (const VuoNdiSource value1, const VuoNdiSource value2)
 Returns true if the two devices have matching names and IP addresses. More...
 
bool VuoNdiSource_isLessThan (const VuoNdiSource value1, const VuoNdiSource value2)
 Returns true if value1 < value2. More...
 
bool VuoNdiSource_isPopulated (const VuoNdiSource source)
 Returns true if the source specifies a name or IP address. More...
 
VuoNdiSource VuoNdiSource_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoNdiSource_getString (const VuoNdiSource value)
 Automatically generated function. More...
 
void VuoNdiSource_retain (VuoNdiSource value)
 Automatically generated function. More...
 
void VuoNdiSource_release (VuoNdiSource value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoNdiSource

struct VuoNdiSource
Class Members
VuoText ipAddress
VuoText name
VuoInteger port

Function Documentation

◆ VuoNdiSource_areEqual()

bool VuoNdiSource_areEqual ( const VuoNdiSource  value1,
const VuoNdiSource  value2 
)

Returns true if the two devices have matching names and IP addresses.

Definition at line 95 of file VuoNdiSource.c.

◆ VuoNdiSource_getJson()

struct json_object* VuoNdiSource_getJson ( const VuoNdiSource  value)

Encodes value as a JSON object.

Definition at line 49 of file VuoNdiSource.c.

◆ VuoNdiSource_getShortSummary()

char* VuoNdiSource_getShortSummary ( const VuoNdiSource  value)

Returns a compact string representation of value.

Definition at line 82 of file VuoNdiSource.c.

◆ VuoNdiSource_getString()

char* VuoNdiSource_getString ( const VuoNdiSource  value)

Automatically generated function.

◆ VuoNdiSource_getSummary()

char* VuoNdiSource_getSummary ( const VuoNdiSource  value)

Returns a compact string representation of value.

Definition at line 67 of file VuoNdiSource.c.

◆ VuoNdiSource_isLessThan()

bool VuoNdiSource_isLessThan ( const VuoNdiSource  value1,
const VuoNdiSource  value2 
)

Returns true if value1 < value2.

Definition at line 112 of file VuoNdiSource.c.

◆ VuoNdiSource_isPopulated()

bool VuoNdiSource_isPopulated ( const VuoNdiSource  source)

Returns true if the source specifies a name or IP address.

Definition at line 123 of file VuoNdiSource.c.

◆ VuoNdiSource_makeFromJson()

VuoNdiSource VuoNdiSource_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"name": "",
"ipAddress": "",
"port": 0,
}

Definition at line 38 of file VuoNdiSource.c.

◆ VuoNdiSource_makeFromString()

VuoNdiSource VuoNdiSource_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoNdiSource_release()

void VuoNdiSource_release ( VuoNdiSource  value)

Automatically generated function.

◆ VuoNdiSource_retain()

void VuoNdiSource_retain ( VuoNdiSource  value)

Automatically generated function.