Open Sound Control (OSC) Specification

Created by Technical Support, Modified on Thu, 29 Oct at 8:04 PM by Technical Support

Find a pre-made TouchOSC interface you can download here

 Using TouchOSC To Control MaestroDMX


Function

OSC Address Path

Data

Range

Notes

Global Brightness

/global/brightness

float

0.0 – 1.0

Sets the global brightness of all lights.

Set Audio Input By Name

/audio/input

string

Audio input name

Selects a specific audio input by its name.

Next Audio Input

/audio/input/next

n/a

n/a

Advances to the next audio input in the input list.

Live Pause

/live/pause

n/a

n/a

Pauses live playback.

Live Resume

/live/resume

n/a

n/a

Resumes live playback.

Live Stop

/live/stop

n/a

n/a

Stops playback.

Live Transition Time

/live/transition

float

Seconds

Sets the fade-in, fade-out, and crossfade time used when live settings change.

Pattern Select

/live/N/pattern

string

Pattern ID

Selects a pattern by its ID [N = zone].

Pattern Select Via Index

/live/N/pattern/index

int

0 – (number of patterns - 1)

Selects a pattern by its position in the pattern list; 0 is the first. Out-of-range values select the nearest valid pattern. Useful for fader interfaces such as TouchOSC [N = zone].

Colour Palette Select

/live/N/palette

string

Palette ID

Selects a colour palette by its ID [N = zone].

Colour Palette Select Via Index

/live/N/palette/index

int

0 – (number of palettes - 1)

Selects a colour palette by its position in the palette list; 0 is the first. Out-of-range values select the nearest valid palette [N = zone].

FX Palette Select

/live/N/fx

string

FX Palette ID

Selects an FX palette by its ID [N = zone].

FX Palette Select Via Index

/live/N/fx/index

int

0 – number of FX palettes

Selects an FX palette by its position in the list; 1 is the first. 0 clears the FX palette [N = zone].

Brightness

/live/N/brightness

float

0.0 – 1.0

Sets the zone brightness [N = zone].

Excitement

/live/N/excitement

float

0.0 – 1.0

Sets the pattern excitement [N = zone].

Background

/live/N/background

float

0.0 – 1.0

Sets the pattern background level [N = zone].

Speed

/live/N/speed

float

0.0 – 1.0

Sets the pattern speed [N = zone].

Energy

/live/N/energy

float

0.0 – 1.0

Sets the pattern energy [N = zone].

Variance

/live/N/variance

float

0.0 – 1.0

Sets the pattern variance [N = zone].

Attack

/live/N/attack

float

0.0 – 1.0

Sets the pattern attack [N = zone].

Decay

/live/N/decay

float

0.0 – 1.0

Sets the pattern decay [N = zone].

Shape

/live/N/shape

float

0.0 – 1.0

Selects the pattern shape. The 0.0 – 1.0 range is spread across all available shapes, so a fader sweeps through them. Note: for core patterns only, works better in 2D [N = zone].

Zone Blackout

/live/N/blackout

boolean

true/false

Blacks out a single zone [N = zone].

Motion Range

/live/N/motion/range

float

0.0 – 1.0

Sets the mover range [N = zone].

Motion Speed

/live/N/motion/speed

float

0.0 – 1.0

Sets the mover speed [N = zone]. /live/N/motion_speed is the same control.

Motion Speed (alternate address)

/live/N/motion_speed

float

0.0 – 1.0

Same control as /live/N/motion/speed [N = zone].

Motion Parameter 1

/live/N/motion_param_1

float

0.0 – 1.0

Sets the first motion parameter of the current motion effect [N = zone].

Motion Parameter 2

/live/N/motion_param_2

float

0.0 – 1.0

Sets the second motion parameter of the current motion effect [N = zone].

Motion Pan Scale

/live/N/motion_pan_scale

float

0.0 – 1.0

Scales the pan movement [N = zone].

Motion Tilt Scale

/live/N/motion_tilt_scale

float

0.0 – 1.0

Scales the tilt movement [N = zone].

Motion Wave

/live/N/motion_wave

float

0.0 – 1.0

Sets the motion wave amount [N = zone].

Motion Gate

/live/N/motion_gate

float

0.0 – 1.0

Sets the motion gate amount [N = zone].

Mirror Motion

/live/N/mirror_motion

boolean

true / false

Turns mirrored mover motion on or off [N = zone].

Motion Audio Reactivity

/live/N/audio_reactivity_motion

boolean

true / false

Turns audio-reactive motion on or off [N = zone].

Zone Audio Reactivity

/live/N/audio_reactivity

boolean

true / false

Turns audio reactivity on or off for the zone [N = zone].

Blackout On Silence

/live/N/blackout_on_silence

boolean

true / false

When on, the zone goes dark when no audio is detected [N = zone].

Allow Blackout

/live/N/allow_blackout

boolean

true / false

Sets whether the Blackout trigger acts on this zone [N = zone].

Allow Blinder

/live/N/allow_blinder

boolean

true / false

Sets whether the Blinder trigger acts on this zone [N = zone].

Allow Strobe

/live/N/allow_strobe

boolean

true / false

Sets whether the Strobe trigger acts on this zone [N = zone].

Allow Fog

/live/N/allow_fog

boolean

true / false

Sets whether the Fog trigger acts on this zone [N = zone].

Allow Effect

/live/N/allow_effect

boolean

true / false

Sets whether Effect triggers act on this zone [N = zone].

Load Show By ID

/show

string

Show ID

Loads a show by its ID.

Load Show By Name

/show/name

string

Show name

Loads a show by its saved name. If several shows share the name, the first one is loaded.

Load Show By Index

/show/index

int

0 – (number of shows - 1)

Loads a show by its position in the show list; 0 is the first.

Next Show

/show/next

n/a

n/a

Loads the next show.

Previous Show

/show/previous

n/a

n/a

Loads the previous show.

Load Cue

/show/cue/index

int

1 – number of cues

Starts a cue by its position in the show; 1 is the first cue.

Load Cue (zero-based)

/show/cue

int

0 – (number of cues - 1)

Starts a cue by its position in the show; 0 is the first cue.

Next Cue

/show/cue/next

n/a

n/a

Moves to the next cue in the show.

Previous Cue

/show/cue/previous

n/a

n/a

Moves to the previous cue in the show.

Show Play

/show/play

n/a

n/a

Plays the loaded show.

Show Pause

/show/pause

n/a

n/a

Pauses the loaded show.

Show Play or Pause

/show/play_pause

n/a

n/a

Toggles between play and pause.

Show Stop

/show/stop

n/a

n/a

Stops the loaded show.

Strobe

/triggers/strobe

boolean

true/false

Momentary strobe: true turns it on, false releases it.

Toggle Strobe

/triggers/strobe/toggle

n/a

n/a

Toggles the strobe on/off.

Strobe Rate

/triggers/strobe/rate

float

0.0 – 1.0

Sets the strobe rate (min – max, 0.5 – 10 Hz).

Strobe Brightness

/triggers/strobe/brightness

float

0.0 – 1.0

Sets the brightness of the strobe.

Strobe Sync

/triggers/strobe/sync

string or int

free, auto, beat (0 – 2)

free = use the rate setting; auto = follow the beat when there is a clear pulse, otherwise the rate setting; beat = always follow the beat.

Strobe Beat Division

/triggers/strobe/beat_division

int

1, 2, 4 or 8

Flashes per beat when the strobe is synced to the beat.

Strobe Shape

/triggers/strobe/shape

string or int

flash, pulse, dark, flicker (0 – 3)

flash = hard flash; pulse = sharp attack with decay; dark = lit with brief blinks to black; flicker = random brightness per fixture.

Strobe Flash Length

/triggers/strobe/flash_length

float

Seconds

Length of each flash. 0 = the shortest possible flash.

Strobe Distribution

/triggers/strobe/distribution

string or int

together, alternate, groups, chase, scattered, chaotic (0 – 5)

Sets how flashes are spread across fixtures: all together, odd/even alternating, fixture groups taking turns, a sweep by position, a fixed random offset, or independent random flashes.

Strobe Chase Direction

/triggers/strobe/chase_direction

string or int

left_to_right, right_to_left, center_out, outside_in (0 – 3)

Direction of the sweep when Strobe Distribution is chase.

Strobe Density

/triggers/strobe/density

float

0.0 – 1.0

Share of fixtures included in each flash.

Strobe Colour Mode

/triggers/strobe/color_mode

string or int

pattern, fixed, palette, palette_cycle, palette_random (0 – 4)

pattern = the pattern's own colour; fixed = the Strobe Colour; palette = palette colours spread across fixtures; palette_cycle = next palette colour each flash; palette_random = random palette colour per flash and fixture.

Strobe White Mix

/triggers/strobe/white_mix

float

0.0 – 1.0

0 = the chosen color, 1 = white.

Strobe Color

/triggers/strobe/color

float float float

0.0 – 1.0 each (r g b)

Colour used when Strobe Colour Mode is fixed. Up to three optional extra values set white, amber, and UV.

Blinder

/triggers/blinder

boolean

true / false

Momentary blinder: true turns it on, false releases it.

Toggle Blinder

/triggers/blinder/toggle

n/a

n/a

Toggles the blinder on/off.

Blinder Brightness

/triggers/blinder/brightness

float

0.0 – 1.0

Sets the brightness of the blinder.

Blinder Colour Mode

/triggers/blinder/color_mode

string or int

pattern, fixed, palette (0 – 2)

pattern = the pattern's own colour; fixed = the Blinder Colour; palette = palette colours spread across fixtures.

Blinder White Mix

/triggers/blinder/white_mix

float

0.0 – 1.0

0 = the chosen color, 1 = white.

Blinder Color

/triggers/blinder/color

float float float

0.0 – 1.0 each (r g b)

Colour used when Blinder Colour Mode is fixed. Up to three optional extra values set white, amber, and UV.

Blinder Tungsten

/triggers/blinder/tungsten

boolean

true/false

Turns the tungsten (warm lamp) look on or off.

Blinder Fade In

/triggers/blinder/fade_in

float

0.0 – 10.0 (seconds)

Fade-in time of the blinder.

Blinder Fade Out

/triggers/blinder/fade_out

float

0.0 – 10.0 (seconds)

Fade-out time of the blinder.

Blinder Fade Curve

/triggers/blinder/curve

string or int

linear, s, dimmer (0 – 2)

Shape of the fade.

Blinder Length

/triggers/blinder/length

string or int

button, hit, half_beat, beat, 2_beats, bar, 2_bars, 4_bars (0 – 7)

button = on for as long as the button is held or latched. The others are one-shot musical lengths.

Blinder Quantize

/triggers/blinder/quantize

string or int

off, beat, bar (0 – 2)

Delays the start of the blinder to the next beat or bar.

Blackout

/triggers/blackout

boolean

true/false

Momentary blackout: true turns it on, false releases it.

Toggle Blackout

/triggers/blackout/toggle

n/a

n/a

Toggles the blackout on/off.

Blackout Depth

/triggers/blackout/depth

float

0.0 – 1.0

How dark the blackout goes. 1 = fully black.

Blackout Fade In

/triggers/blackout/fade_in

float

0.0 – 10.0 (seconds)

Fade-in time of the blackout.

Blackout Fade Out

/triggers/blackout/fade_out

float

0.0 – 10.0 (seconds)

Fade-out time of the blackout.

Blackout Fade Curve

/triggers/blackout/curve

string or int

linear, s, dimmer (0 – 2)

Shape of the fade.

Blackout Length

/triggers/blackout/length

string or int

button, hit, half_beat, beat, 2_beats, bar, 2_bars, 4_bars (0 – 7)

button = on for as long as the button is held or latched. The others are one-shot musical lengths.

Blackout Quantize

/triggers/blackout/quantize

string or int

off, beat, bar (0 – 2)

Delays the start of the blackout to the next beat or bar.

Fog

/triggers/fog

boolean

true/false

Momentary fog: true turns it on, false turns it off.

Toggle Fog

/triggers/fog/toggle

n/a

n/a

Toggles fog on/off.

Fog Interval

/triggers/fog/interval

float

0.0 – 1.0

In timer mode, sets the time between fog bursts (0 – 300 seconds).

Fog Duration

/triggers/fog/duration

float

0.0 – 1.0

In timer mode, sets how long each fog burst lasts (0 – 300 seconds).

Fog Volume

/triggers/fog/volume

float

0.0 – 1.0

Sets the fog volume.

Fog Speed

/triggers/fog/speed

float

0.0 – 1.0

Sets the fog speed.

Effect

/triggers/effect

boolean

true/false

Momentary effect for the built-in Effect button (Effect 0).

Toggle Effect

/triggers/effect/toggle

n/a

n/a

Toggles the built-in Effect button (Effect 0) on/off.

Numbered Effect

/triggers/effect/E

boolean

true/false

Momentary effect for a numbered Effect button [E = effect number, 0 – 7]. Send exactly one value.

Toggle Numbered Effect

/triggers/effect/E/toggle

n/a

n/a

Toggles a numbered Effect button on/off [E = effect number, 0 – 7]. Send no value.

Fader

/triggers/fader/F

float

0.0 – 1.0

Sets the value of a fader [F = fader number, 0 – 7].

Reset Triggers

/triggers/reset

n/a

n/a

Clears strobe, blinder, blackout and effects. Does not turn off fog.






NOTES

MaestroDMX listens for OSC over UDP on port 7672.

N = zone number, starting at 1 (1 – 10 by default). Zones were called Groups in earlier versions. E = effect number and F = fader number, both 0 – 7; number 0 is the built-in button/fader. Sending a number with nothing assigned does nothing.

Boolean values can be sent as OSC true/false (T/F), as a float (0.0 = false, anything else = true – what TouchOSC sends), or as an int (0 / 1).

"string or int" settings accept either the lowercase name shown in Range (for example "chase") or its number, counting from 0 in the order listed.

Wildcards: the zone, effect and fader number in an address can use OSC patterns to address several at once, e.g. /live/*/brightness (every zone), /live/{1,3}/brightness (zones 1 and 3), /live/[1-4]/brightness (zones 1 to 4), /triggers/fader/* (every fader). Zones addressed this way change together. Wildcards are not accepted anywhere else in an address.

A message with the wrong data type, or an unknown address, is ignored.

Strobe and blinder safety limits cannot be changed over OSC.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article