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

Description

An OSC message.

Classes

struct  _VuoOscMessage
 An OSC message. More...
 

Macros

#define VUOOSC_MAX_MESSAGE_ARGUMENTS   256
 Maximum supported number of OSC message arguments.
 

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, unsigned int dataCount, struct json_object **data, VuoOscType *dataTypes)
 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.
 
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[VUOOSC_MAX_MESSAGE_ARGUMENTS]
unsigned int dataCount
VuoOscType dataTypes[VUOOSC_MAX_MESSAGE_ARGUMENTS]

Macro Definition Documentation

#define VUOOSC_MAX_MESSAGE_ARGUMENTS   256

Maximum supported number of OSC message arguments.

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.

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,
unsigned int  dataCount,
struct json_object **  data,
VuoOscType dataTypes 
)

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 the json_objects in data (expected to have json_object retain count 1); the caller should not json_object_put the objects, or modify them 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.