OSC (Open Sound Control)
An overview of Aitums Open Sound Control triggers and actions
Aitum supports the OSC (Open Sound Control) protocol. The protocol can be used to control numerous third-party software, such as Logic Pro, TouchDesigner, Q Light Controller, Unreal Engine and more.
Setup
To setup OSC, you need to add it as an integration, which is a quick and easy process. Open Aitum and head to the Settings tab, then click Integrations. Click New Integration, then select OSC from the list of integration types.
You can now determine whether you’d like to be able to send OSC and/or receive OSC. If you enable Send OSC, you will need to specify a Send IP and Send Port for sending your OSC data. If you enable Receive OSC, you will need to specify a Receive Port to receive the data on.
Triggers
Float
Activated when receiving Float data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Local Variable Usage | Visible in Trigger | Description |
|---|---|---|---|---|---|---|
| Address | No | Text | Yes | Yes | Yes | The address the data came from |
| Value | No | Decimal | Yes | Yes | Yes | The value that was sent |
Integer
Activated when receiving Integer data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Local Variable Usage | Visible in Trigger | Description |
|---|---|---|---|---|---|---|
| Address | No | Text | Yes | Yes | Yes | The address the data came from |
| Value | No | Whole Number | Yes | Yes | Yes | The value that was sent |
String
Activated when receiving String data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Local Variable Usage | Visible in Trigger | Description |
|---|---|---|---|---|---|---|
| Address | No | Text | Yes | Yes | Yes | The address the data came from |
| Value | No | Text | Yes | Yes | Yes | The value that was sent |
Null
Activated when receiving Null data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Local Variable Usage | Visible in Trigger | Description |
|---|---|---|---|---|---|---|
| Address | No | Text | Yes | Yes | Yes | The address the data came from |
Boolean
Activated when receiving Boolean data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Local Variable Usage | Visible in Trigger | Description |
|---|---|---|---|---|---|---|
| Address | No | Text | Yes | Yes | Yes | The address the data came from |
| Value | No | Boolean | Yes | Yes | Yes | The value that was sent |
Actions
Float
Send Float data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Description |
|---|---|---|---|---|
| Address | Yes | Text | Yes | The address to send the data to |
| Value | Yes | Decimal | Yes | The value to send |
Integer
Send Integer data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Description |
|---|---|---|---|---|
| Address | Yes | Text | Yes | The address to send the data to |
| Value | Yes | Whole Number | Yes | The value to send |
String
Send String data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Description |
|---|---|---|---|---|
| Address | Yes | Text | Yes | The address to send the data to |
| Value | Yes | Text | Yes | The value to send |
Null
Send Null data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Description |
|---|---|---|---|---|
| Address | Yes | Text | Yes | The address to send the data to |
Boolean
Send Boolean data over OSC.
Fields:
| Field | Required | Field Type | Allows Variables | Description |
|---|---|---|---|---|
| Address | Yes | Text | Yes | The address to send the data to |
| Value | Yes | Boolean | Yes | The value to send |