OSC messages in Aximmetry

Introduction

In this document you will find information on how to use OSC messages in Aximmetry received from an OSC input, and how to create and send OSC messages from Aximmetry.

You can read more on the OSC protocol in the OSC section of the general Controllers document.

There is a separate document that describes how to set up In- and Outputs only. Please find it here.

Input

Controlling module properties and control board buttons

The usual scenario is that the incoming OSC messages only contain an address and a single floating-point number (or alternatively an integer, logical, or double value). This kind of message can be used to control properties and buttons just like with MIDI or DMX controllers.

Right-click the name of a numeric or a logical property

or a control board button and choose Assign OSC...

 

Then simply send the appropriate OSC message from your controller device (e.g. move a fader or press a button) and the assignment is made.

NOTE: if you write your own controller software, please note that in order to turn on a button in normal mode you have to send a value of 1 and for turning off you have to send a value of 0.

To see and manage all the OSC assignments you made in your compound go to File / Properties / OSC Assignments.

Controlling the Flow graph

You can build controlling structures within the flow graph using the OSC modules.

Scalar input

For the OSC messages containing a single floating point number (or alternatively an integer, logical, or double value) you can use the OSC Scalar module.

For the module, you have to specify an OSC Address.

It can be entered manually, but you can also use the Learn function. Turn On Learn

then move/press a fader/button on your OSC controlling device. The address will be filled in automatically.

Vector input

If the OSC message contains an arbitrary number of floating-point values representing a 2D or 3D position or any arbitrary series of numbers you can use the OSC Vector module.

Trigger input

The OSC Trigger module sends a signal each time an OSC message containing any non-zero value arrives.

General input

OSC messages can contain any number of arguments of various types. To handle any general case use the OSC Method module.

It outputs a collection with each argument assigned the keys 1, 2, 3, etc. In this example below, we’ve received a message with 5 arguments of types float, string, Nil, integer, and a logical true (,fsNiT).

In order to access the individual arguments, you can use the standard Collection modules. E.g. if you need the second string argument use the Collection Text module:

To access the second argument enter 2 into the Key property (please pay attention to not entering the number into the Index property which is incorrect in this case).

You can access the other arguments similarly.

On handling the collection data type in general see more info, see .

Sending OSC output

For the opposite scenario, when you want to control external devices from Aximmetry via OSC use the OSC * Out modules.

Scalar and vector output

For single numeric values or a series of numbers use the OSC Scalar Out and OSC Vector Out modules.

For these, you have to specify an output Device (from the list you’ve created in the initial setup, see above), and a target address.

The actual sending of the message can be performed in two ways. You can send it at a specific time by triggering it via the Send pin. Alternatively, you can turn On Auto Send, in this case, each time the Argument value is changed it is sent automatically.

General output

For sending an arbitrary number of arguments of any type use the OSC Out module.

E.g. to achieve the message structure we’ve seen above do the following:

Please note that we do not add any argument for Key = 3 in this example. In this case, a Nil element will be inserted as the third argument.