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

Description

An OSC message.

Classes

struct  _VuoOscMessage
 An OSC message. More...
 

Typedefs

typedef struct _VuoOscMessageVuoOscMessage
 An OSC message.
 

Functions

void VuoOscMessage_free (void *message)
 Releases the message's values and frees the message object.
 
VuoOscMessage VuoOscMessage_make (VuoText address, json_object *data)
 Creates an OSC message having the specified address and carrying the specified data.
 
VuoOscMessage VuoOscMessage_makeFromJson (json_object *js)
 Decodes the JSON object js to create a new value.
 
json_objectVuoOscMessage_getJson (const VuoOscMessage value)
 Encodes value as a JSON object.
 
char * VuoOscMessage_getSummary (const VuoOscMessage value)
 Produces a brief human-readable summary of value.
 
int VuoOscMessage_getDataCount (const VuoOscMessage value)
 Returns the number of data values in the OSC message.
 
struct json_objectVuoOscMessage_getDataJson (const VuoOscMessage value, int index)
 Returns a JSON object representing the OSC message's data value at index.
 
VuoOscMessage VuoOscMessage_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoOscMessage_getString (const VuoOscMessage value)
 Automatically generated function.
 
void VuoOscMessage_retain (VuoOscMessage value)
 Automatically generated function.
 
void VuoOscMessage_release (VuoOscMessage value)
 Automatically generated function.
 

Class Documentation

struct _VuoOscMessage
Class Members
VuoText address
struct json_object * data

Typedef Documentation

typedef struct _VuoOscMessage * VuoOscMessage

An OSC message.

Function Documentation

void VuoOscMessage_free ( void *  message)

Releases the message's values and frees the message object.

This function may be called from any thread.

int VuoOscMessage_getDataCount ( const VuoOscMessage  value)

Returns the number of data values in the OSC message.

struct json_object* VuoOscMessage_getDataJson ( const VuoOscMessage  value,
int  index 
)
read

Returns a JSON object representing the OSC message's data value at index.

The index values start at 1.

struct json_object * VuoOscMessage_getJson ( const VuoOscMessage  value)
read

Encodes value as a JSON object.

char* VuoOscMessage_getString ( const VuoOscMessage  value)

Automatically generated function.

char * VuoOscMessage_getSummary ( const VuoOscMessage  value)

Produces a brief human-readable summary of value.

VuoOscMessage VuoOscMessage_make ( VuoText  address,
json_object data 
)

Creates an OSC message having the specified address and carrying the specified data.

data should be a JSON array, and can contain zero or more values of any type.

The VuoOscMessage takes ownership of data (expected to have json_object retain count 1); the caller should not json_object_put it, or modify it after calling this function.

VuoOscMessage VuoOscMessage_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"address" : "/foo",
"data" : [ ... ]
}
VuoOscMessage VuoOscMessage_makeFromString ( const char *  str)

Automatically generated function.

void VuoOscMessage_release ( VuoOscMessage  value)

Automatically generated function.

void VuoOscMessage_retain ( VuoOscMessage  value)

Automatically generated function.