Device - OSC

The Triggers and Actions system supports the configuration of OSC (Open Sound Control) devices for sending OSC messages as Actions. These devices can be used to integrate with external systems by defining actions that send OSC messages to specific hosts and ports.

The settings for OSC devices are stored in

C:\ProgramData\Igloo Vision\IglooCoreEngine\settings\triggers and actions\devices\osc\OSCSettings.xml

Device Configuration

Below is an example configuration file for an OSC device:

<oscDevices>
	<oscDevice>
		<network name="OSC - Device One">
			<host>127.0.0.1</host> 
			<port>7001</port>
		</network>
		<actions> 
			<action name="SetLightRed" address="/light/colour" type="set">
				<arguments>
					<argument name="red" type="int" value="255" />
					<argument name="green" type="int" value="0" />
					<argument name="blue" type="int" value="0" />
				</arguments>
			</action>
			<action name="ControlLightColour" address="/light/colour" type="control">
				<arguments>
					<argument name="red" type="int" min="0" max="255" />
					<argument name="green" type="int" min="0" max="255" />
					<argument name="blue" type="int" min="0" max="255" />
				</arguments>
			</action>
		</actions>
	</oscDevice>
</oscDevices>

Key Elements

Network Configuration

name: A unique identifier for the OSC device.
host: The IP address of the OSC target.
port: The port number of the OSC target.

Actions

Actions define how OSC messages are sent. Two types of actions are supported Set and Control

Set Actions: Used to send static values.
- type: set
- address: The OSC address for the action.
- arguments: Define the static values to send.
  - name: The name of the OSC argument.
  - type: Data type (int, float, etc.).
  - value: The static value to send.
Example:
<action name="SetLightRed" address="/light/colour" type="set"> <arguments> <argument name="red" type="int" value="255" /> <argument name="green" type="int" value="0" /> <argument name="blue" type="int" value="0" /> </arguments> </action>
Control Actions: Used for dynamic control with adjustable parameters.
- type: control
- address: The OSC address for the action.
- arguments: Define the range of values for each parameter.
  - name: The name of the argument.
  - type: Data type (int, float, etc.).
  - min: Minimum value.
  - max: Maximum value.
Example:
<action name="ControlLightColour" address="/light/colour" type="control"> <arguments> <argument name="red" type="int" min="0" max="255" /> <argument name="green" type="int" min="0" max="255" /> <argument name="blue" type="int" min="0" max="255" /> </arguments> </action>

Using OSC Actions

Once configured, OSC actions can be used within the Triggers and Actions system, appearing in the

Set Actions will appear as events with no parameters.

Control Actions will appear as events with parameters exposed for dynamic control.

Example Use Case

Define a Trigger (e.g., A Session is Loaded or video playback reaches a specified time).
Link the Trigger to an OSC action.
Use the OSC action to send messages to an external system (e.g., lighting controller or media server).