Osc control, Received osc commands, Ping s:returnurl s:returnpath – Expert Sleepers Oomingmak v1.0.0 User Manual

Page 24: Set i:param f:value, Get i:param s:returnurl s:returnpath

Advertising
background image

OSC Control

Oomingmak can be controlled via the Open Sound Control (OSC) protocol.

If you’re new to OSC, start by visiting

opensoundcontrol.org

.

Two settings control what port the plug-in uses to listen on for OSC com-
mands. One is the base OSC port, set in the

preferences

. The second is the

OSC Port Offset control. If the port offset is set to something other than
‘Off’, then the two numbers are added together and the result used as the
port number. E.g. if the base port is 6000 and the port offset is 1, then the
plug-in will listen on port 6001.

Received OSC Commands

In the documentation below, OSC parameters are prefixed with a string to indicate their
type, as follows:

s - string

i - integer

f - float

b - boolean

All the examples assume that the plug-in is listening at address 10.0.0.1:6001.

/ping s:returnUrl s:returnPath

Responds by sending a message back to the returnUrl and returnPath with the parameters

s:hosturl s:version

E.g.

/ping osc.udp://10.0.0.2:7000 “/foo”

replies to 10.0.0.2:7000 with

/foo osc.udp://10.0.0.1:6001 “Oomingmak 1.0.0”

/set i:param f:value

Sets the value of parameter ‘param’ to ‘value’.

/get i:param s:returnUrl s:returnPath

Responds by sending a message back to the returnUrl and returnPath with the parameters

i:param f:value

where ‘value’ is the value of parameter ‘param’. E.g.

/get 14 osc.udp://10.0.0.2:7000 “/foo”

Advertising