ola::plugin::osc Namespace Reference

Detailed Description

Code for the OSC protocol.

Classes
class	OSCDevice
class	OSCInputPort
	The Input Port class, for receiving DMX via OSC. More...
class	OSCNode
class	OSCOutputPort
class	OSCPlugin
struct	OSCTarget

Functions
string	ExpandTemplate (const string &str, unsigned int value)
void	OSCErrorHandler (int error_code, const char *msg, const char *stack)
bool	ExtractSlotFromPath (const string &osc_address, string *group_address, uint16_t *slot)
bool	ExtractSlotValueFromPair (const string &type, lo_arg **argv, int argc, uint16_t *slot, uint8_t *value)
int	OSCDataHandler (const char *osc_address, const char *types, lo_arg **argv, int argc, void *, void *user_data)

Variables
const char	plugin_description []

Function Documentation

ExpandTemplate()

std::string ola::plugin::osc::ExpandTemplate	(	const string &	str,
		unsigned int	value
	)

If the string contains d, replace it with the given value. This only replaces the first instance of d.

Parameters

str	the template string to use
value	the value to use as the replacement.

Returns

str with d replaced by value.

ExtractSlotFromPath()

bool ola::plugin::osc::ExtractSlotFromPath	(	const string &	osc_address,
		string *	group_address,
		uint16_t *	slot
	)

Extract the slot number and group address from an OSC address

ExtractSlotValueFromPair()

bool ola::plugin::osc::ExtractSlotValueFromPair	(	const string &	type,
		lo_arg **	argv,
		int	argc,
		uint16_t *	slot,
		uint8_t *	value
	)

Extract the slot and value from a tuple (either ii or if)

OSCDataHandler()

int ola::plugin::osc::OSCDataHandler	(	const char *	osc_address,
		const char *	types,
		lo_arg **	argv,
		int	argc,
		void *	,
		void *	user_data
	)

Called when liblo receives data.

Parameters

osc_address	the OSC Address this data was sent to
types	the OSC data type for the data
argv	the data itself
argc	the number of data blocks
user_data	a pointer to the OSCNode object.