VuoOsc.h File Reference

Description

VuoOsc interface.

Copyright

Copyright © 2012–2015 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Typedefs
typedef void *	VuoOscIn
	Manages receiving messages via OSC.
typedef void *	VuoOscOut
	Manages sending OSC output.

Functions
void	VuoOsc_use (void)
	Indicates that the caller needs to get notifications about OSC devices.
void	VuoOsc_disuse (void)
	Indicates that the caller no longer needs notifications about OSC devices.
VuoList_VuoOscInputDevice	VuoOsc_getInputDeviceList (void)
	Returns a list of the currently-avaialble OSC input devices.
VuoList_VuoOscOutputDevice	VuoOsc_getOutputDeviceList (void)
	Returns a list of the currently-avaialble OSC output devices.
void	VuoOsc_addDevicesChangedTriggers (VuoOutputTrigger(inputDevices, VuoList_VuoOscInputDevice), VuoOutputTrigger(outputDevices, VuoList_VuoOscOutputDevice))
	Adds a trigger callback, to be invoked whenever the list of known OSC devices changes.
void	VuoOsc_removeDevicesChangedTriggers (VuoOutputTrigger(inputDevices, VuoList_VuoOscInputDevice), VuoOutputTrigger(outputDevices, VuoList_VuoOscOutputDevice))
	Removes a trigger callback previously added by VuoOsc_addDevicesChangedTriggers.
VuoOscIn	VuoOscIn_make (const VuoOscInputDevice device)
	Creates a reference-counted object to manage receiving messages from a OSC device.
void	VuoOscIn_enableTriggers (VuoOscIn oi, VuoOutputTrigger(receivedMessage, VuoOscMessage))
	Sets up the OSC server to call the trigger functions when it receives a message.
void	VuoOscIn_disableTriggers (VuoOscIn oi)
	Stops the OSC server from calling trigger functions when it receives a message.
VuoOscOut	VuoOscOut_getShared (const VuoOscOutputDevice device)
	Returns the reference-counted object for the specified OSC output device.
void	VuoOscOut_sendMessages (VuoOscOut oo, VuoList_VuoOscMessage messages)
	Sends a message to the specified OSC device.

Typedef Documentation

typedef void* VuoOscIn

Manages receiving messages via OSC.

typedef void* VuoOscOut

Manages sending OSC output.

Function Documentation

void VuoOsc_addDevicesChangedTriggers	(	VuoOutputTrigger(inputDevices, VuoList_VuoOscInputDevice)	,
		VuoOutputTrigger(outputDevices, VuoList_VuoOscOutputDevice)
	)

Adds a trigger callback, to be invoked whenever the list of known OSC devices changes.

Call VuoOsc_use() before calling this.

This function may be called from any thread.

void VuoOsc_disuse

(

void

)

Indicates that the caller no longer needs notifications about OSC devices.

This function may be called from any thread.

VuoList_VuoOscInputDevice VuoOsc_getInputDeviceList

(

void

)

Returns a list of the currently-avaialble OSC input devices.

VuoList_VuoOscOutputDevice VuoOsc_getOutputDeviceList

(

void

)

Returns a list of the currently-avaialble OSC output devices.

void VuoOsc_removeDevicesChangedTriggers	(	VuoOutputTrigger(inputDevices, VuoList_VuoOscInputDevice)	,
		VuoOutputTrigger(outputDevices, VuoList_VuoOscOutputDevice)
	)

Removes a trigger callback previously added by VuoOsc_addDevicesChangedTriggers.

This function may be called from any thread.

void VuoOsc_use

(

void

)

Indicates that the caller needs to get notifications about OSC devices.

This function may be called from any thread.

void VuoOscIn_disableTriggers

(

VuoOscIn

oi

)

Stops the OSC server from calling trigger functions when it receives a message.

This function may be called from any thread.

void VuoOscIn_enableTriggers	(	VuoOscIn	oi,
		VuoOutputTrigger(receivedMessage, VuoOscMessage)
	)

Sets up the OSC server to call the trigger functions when it receives a message.

This function may be called from any thread.

VuoOscIn VuoOscIn_make

(

const VuoOscInputDevice

device

)

Creates a reference-counted object to manage receiving messages from a OSC device.

If the device's port is nonzero, attempts to use the specified port. If zero, automatically chooses an unused port. If the port is successfully opened, advertises the server via Bonjour.

VuoOscOut VuoOscOut_getShared

(

const VuoOscOutputDevice

device

)

Returns the reference-counted object for the specified OSC output device.

void VuoOscOut_sendMessages	(	VuoOscOut	oo,
		VuoList_VuoOscMessage	messages
	)

Sends a message to the specified OSC device.