How to control Proxima using the OSC API ?

Créé par Waves System, Modifié le  Mar, 16 Sept. à 5:13 H par  Waves System

TABLE OF CONTENTS


In addition to the ability to assign your own OSC addresses using the Learning Mode, you can use the default OSC addresses already in place.

Each assignable element of the interface has at least one address. If it has more than one address, it means the same result can be achieved in multiple ways. For example, if you want to edit a sequence, you can reach it via its name or by its position, meaning there are 2 addresses for a single action.


Ready-to-use templates using the OSC API

The API can be used to build custom templates for any project without going through the Learning process. To make things easier, we’ve created a few templates using the popular OSC app TouchOSC. You can use them as-is or quickly copy-paste objects to build your own.


FileDescriptionFormatProject
Sequencer_v1A template focusing on live Sequences control, with 4 tabs of 8x8 sequences and a few Master Shaders shortcuts2160×1620 (iPad 9)-
GroupEffects_v1A simple template containing Group effects parameters (no LFO control)2160×1620 (iPad 9)-
Mix_v1A template with an A/B crossfader, intended to control the simple mix of 2 blended Groups. An example project is provided (see 4th column).2160×1620 (iPad 9)Example


TouchOSC Screenshot


API reading instructions

The full list of messages in the API can be found in the tables below. Each table follows the same structure:

  • 1st column: description of the action
  • 2nd column: default OSC address(es)
  • 3rd column: argument (always float unless stated)


Note
The value in the 3rd column also usually represents what is sent back via feedback. For Coordinates and Dimensions, feedback is disabled to avoid infinite loop issues.



We’ve used abbreviations throughout the article. In a table, if you see a word between [brackets], refer to the following instructions to understand what’s expected in the address:

  • [n] corresponds to an integer number, for example, the row number of a sequence or the position of a group in the Layers list. For shader and group lists, the count starts from the bottom, at 1.
  • [seqName] corresponds to the name given to the sequence, without spaces. For example, if you’ve named it "Act 1-2", then [seqName] = act1-2.
  • [groupName] corresponds to the name given to the group, without spaces. For example, if you’ve named it "Group 4", then [groupName] = group4.
  • [mapName] corresponds to the name given to the map, without spaces. For example, if you’ve named it "Map 12", then [mapName] = map12.
  • [shapeName] corresponds to the name given to the shape (face or player), without spaces. For example, if you’ve named it "Face 4", then [shapeName] = face4.
  • [playerName] corresponds to the name given to the player, without spaces. For example, if you’ve named it "Player 4_2", then [playerName] = player4_2.
  • [vertexName] corresponds to the name of the vertex displayed in the header of the Properties panel when selected, without spaces. For example, if your point is named "Vertex 192", then [vertexName] = vertex192.
  • [cueName] corresponds to the name given to the cue, without spaces. For example, if you’ve named it "Play Act 1-2", then [cueName] = playact1-2.
  • [shaderName] corresponds to the name of the shader displayed in the interface, without spaces and file extension. For example, if your shader is named "Chroma Zoom", then [shaderName] = chromazoom.
  • [parameterName] corresponds to the name of the parameter displayed in the interface, without spaces. It always relates to shaders. For example, if your parameter says "master_zoom", then [parameterName] = master_zoom.
  • [variable] depends on the type of parameter you’re targeting. For group effects, [variable] always refers to a parameter using a slider. For shaders, there are a few additional possibilities.
  • [variable] depends on the type of parameter you’re targeting. For group effects, [variable] always refers to a parameter using a slider. For shaders, there are a few additional possibilities.
    Here is what [variable]can mean (with arguments between parenthesis):
    • If the parameter uses a slider, you can target its value but also the properties linked to its LFO variations:
      • value (0.0 (0) to 1.0 (100))
      • lfo/mode (0.0 Fixed ; 0.1 Sine ; 0.2 Triangle ; 0.3 Trapezoid ; 0.4 Square ; 0.5 Saw Up ; 0.6 Saw Down ; 0.7 Noise ; 0.8 Bass ; 0.9 Mid ; 1.0 High)
      • lfo/min (0.0 (0) to 1.0 (100))
      • lfo/max (0.0 (0) to 1.0 (100))
      • lfo/tempo (0.0 (0) to 1.0 (100))
      • lfo/speed (0.0 (0) to 1.0 (100))
    • If the parameter uses a checkbox: value (0.0 (unchecked) or 1.0 (checked))
    • If the parameter uses a list: value (0.0 (top item) to 1.0 (bottom item))
    • If the parameter is an event, using a button: trigger (1 to trigger)
    • If the parameter is a point, using an x and y graph:
      • x (0.0 (min) to 1.0 (max))
      • y (0.0 (min) to 1.0 (max))
  • [colorVariable] is used when the parameter is a color and depends on whether you are targeting a Fixed color or a color of another LFO type. Here is what [colorVariable]can mean (with arguments between parenthesis):
    • Fixed or single color:
      • r/value (0.0 (0) to 1.0 (255))
      • g/value (0.0 (0) to 1.0 (255))
      • b/value (0.0 (0) to 1.0 (255))
      • h/value (0.0 (1) to 1.0 (360))
      • s/value (0.0 (0) to 1.0 (100))
      • v/value (0.0 (0) to 1.0 (100))
      • a/value (0.0 (0) to 1.0 (100))
      • [n]/select (1.0) with [n] being the position of the saved color from 1 (top left) to 20 (bottom right)
    • LFO colors:
      • lfo/mode (0.0 Fixed ; 0.1 Sine ; 0.2 Triangle ; 0.3 Trapezoid ; 0.4 Square ; 0.5 Saw Up ; 0.6 Saw Down ; 0.7 Noise ; 0.8 Bass ; 0.9 Mid ; 1.0 High)
      • lfo/min/r/value (0.0 (0) to 1.0 (255))
      • lfo/min/g/value (0.0 (0) to 1.0 (255))
      • lfo/min/b/value (0.0 (0) to 1.0 (255))
      • lfo/min/h/value (0.0 (1) to 1.0 (360))
      • lfo/min/s/value (0.0 (0) to 1.0 (100))
      • lfo/min/v/value (0.0 (0) to 1.0 (100))
      • lfo/min/a/value (0.0 (0) to 1.0 (100))
      • lfo/min/[n]/select (1.0) with [n] being the position of the saved color from 1 (top left) to 20 (bottom right)
      • lfo/max/r/value (0.0 (0) to 1.0 (255))
      • lfo/max/g/value (0.0 (0) to 1.0 (255))
      • lfo/max/b/value (0.0 (0) to 1.0 (255))
      • lfo/max/h/value (0.0 (1) to 1.0 (360))
      • lfo/max/s/value (0.0 (0) to 1.0 (100))
      • lfo/max/v/value (0.0 (0) to 1.0 (100))
      • lfo/max/a/value (0.0 (0) to 1.0 (100))
      • lfo/max/[n]/select (1.0) with [n] being the position of the saved color from 1 (top left) to 20 (bottom right)
      • lfo/tempo (0.0 (0) to 1.0 (100))
      • lfo/speed (0.0 (0) to 1.0 (100))


List of default OSC messages

Here are the tables you’ll find below:



Master

Master opacity

Opacity
/master/opacity/value
0.0 (0%) to 1.0 (100%)

Master shaders

ActionOSC AddressArgument
Toggle all
/master/shaders/all/toggle
1 (on) or 0 (off)
Toggle one
/master/shaders/[shaderName]/toggle
/master/shaders/[n]/toggle
1 (on) or 0 (off)
Parameters
// Color parameters
/master/shaders/[shaderName]/[parameterName]/[colorVariable]
/master/shaders/[n]/[parameterName]/[colorVariable]

// Other parameters
/master/shaders/[shaderName]/[parameterName]/[variable]
/master/shaders/[n]/[parameterName]/[variable]
Depends on [variable] or [colorVariable]


Examples for Chroma Zoom.fs, in second position from the bottom of the list:

/master/shaders/chromazoom/toggle
/master/shaders/2/toggle

/master/shaders/chromazoom/master_zoom/value
/master/shaders/chromazoom/master_zoom/lfo/mode
/master/shaders/chromazoom/master_zoom/lfo/min
/master/shaders/chromazoom/master_zoom/lfo/max
/master/shaders/chromazoom/master_zoom/lfo/tempo
/master/shaders/chromazoom/master_zoom/lfo/speed

/master/shaders/2/master_zoom/value
...

Sequencer

Sequence controls

ActionOSC AddressArgument
Edit
/sequences/[seqName]/edit
/sequences/tabs/[n]/rows/[n]/columns/[n]/edit
1
Play
/sequences/[seqName]/play
/sequences/edited/play
/sequences/tabs/[n]/rows/[n]/columns/[n]/play
1 (play) or 0 (stop)
Play previous
/sequences/playprevious
1
Play next
/sequences/playnext
1
Play blackout
/sequences/blackout
1


Examples for a sequence named "Seq 1-2", located in the second tab, row 2 & column 2:

/sequences/seq1-2/edit
/sequences/tabs/2/rows/2/columns/2/edit

/sequences/seq1-2/play
/sequences/tabs/2/rows/2/columns/2/play

Sequence transitions

ActionOSC AddressArgument
Parameters
/sequences/[seqName]/transition/[parameterName]/[variable]
/sequences/edited/transition/[parameterName]/[variable]
/sequences/tabs/[n]/rows/[n]/columns/[n]/transition/[parameterName]/[variable]
Depends on [variable]


Examples for a sequence named "Seq 1-2", located in the second tab, row 2 & column 2, with an Angular transition:

/sequences/seq1-2/transition/startingangle/value
/sequences/edited/transition/startingangle/value
/sequences/tabs/2/rows/2/columns/2/transition/startingangle/value

/sequences/seq1-2/transition/startingangle/lfo/mode
/sequences/seq1-2/transition/startingangle/lfo/min
/sequences/seq1-2/transition/startingangle/lfo/max
/sequences/seq1-2/transition/startingangle/lfo/tempo
/sequences/seq1-2/transition/startingangle/lfo/speed
...

Sequence shaders

ActionOSC AddressArgument
Toggle all (2.13.5)
/sequences/[seqName]/shaders/all/toggle
/sequences/edited/shaders/all/toggle
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/all/toggle
1 (on) or 0 (off)
Toggle one
/sequences/[seqName]/shaders/[shaderName]/toggle
/sequences/edited/shaders/[shaderName]/toggle
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/[shaderName]/toggle
/sequences/[seqName]/shaders/[n]/toggle
/sequences/edited/shaders/[n]/toggle
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/[n]/toggle
1 (on) or 0 (off)
Parameters
// Color parameters
/sequences/[seqName]/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/edited/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/[seqName]/shaders/[n]/[parameterName]/[colorVariable]
/sequences/edited/shaders/[n]/[parameterName]/[colorVariable]
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/[n]/[parameterName]/[colorVariable]

// Other parameters
/sequences/[seqName]/shaders/[shaderName]/[parameterName]/[variable]
/sequences/edited/shaders/[shaderName]/[parameterName]/[variable]
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/[shaderName]/[parameterName]/[variable]
/sequences/[seqName]/shaders/[n]/[parameterName]/[variable]
/sequences/edited/shaders/[n]/[parameterName]/[variable]
/sequences/tabs/[n]/rows/[n]/columns/[n]/shaders/[n]/[parameterName]/[variable]
Depends on [variable] or [colorVariable]


Examples for a sequence named "Seq 1-2", located in the second tab, row 2 & column 2, with Chroma Zoom.fs, in second position from the bottom of its list:

/sequences/seq1-2/shaders/chromazoom/toggle
/sequences/edited/shaders/chromazoom/toggle
/sequences/tabs/2/rows/2/columns/2/shaders/chromazoom/toggle
/sequences/seq1-2/shaders/2/toggle
/sequences/edited/shaders/2/toggle
/sequences/tabs/2/rows/2/columns/2/shaders/2/toggle

/sequences/seq1-2/shaders/chromazoom/master_zoom/value
/sequences/seq1-2/shaders/chromazoom/master_zoom/lfo/mode
/sequences/seq1-2/shaders/chromazoom/master_zoom/lfo/min
/sequences/seq1-2/shaders/chromazoom/master_zoom/lfo/max
/sequences/seq1-2/shaders/chromazoom/master_zoom/lfo/tempo
/sequences/seq1-2/shaders/chromazoom/master_zoom/lfo/speed
...

Tabs

ActionOSC AddressArgument
Select
/sequences/tabs/[tabName]/select
/sequences/tabs/[n]/select
1
Select previous
/sequences/tabs/selectprevious
1
Select next
/sequences/tabs/selectnext
1


Examples for a tab named "Draft 1", in second position from the left:

/sequences/tabs/draft1/select
/sequences/tabs/2/select

Autopilot

ActionOSC AddressArgument
Toggle
/autopilot/toggle
1 (on) or 0 (off)
Select direction
/autopilot/direction
0 (left to right) or 1 (random)


Timeline

ActionOSC AddressArgument
Play / Pause
/timeline/play
1 (play) or 0 (pause)
Stop
/timeline/stop
1
Playhead position
/timeline/playhead/position
0.0 (start) to 1.0 (end)
Go to cue
/timeline/cues/[cueName]/goto
/timeline/cues/[n]/goto
1
Go to next cue
/timeline/next
1
Go to previous cue
/timeline/previous
1
Cue timestamp
/timeline/cues/[cueName]/timestamp
/timeline/cues/[n]/timestamp
0.0 (start) to 1.0 (end)


Examples for a cue named "Play Seq 1-2", in second place from the left:

/timeline/cues/playseq1-2/goto
/timeline/cues/2/goto

/timeline/cues/playseq1-2/timestamp
/timeline/cues/2/timestamp

Audio Analysis

ActionOSC AddressArgument
Toggle
/audioanalysis/toggle
1 (on) or 0 (off)
Global gain
/audioanalysis/gain/global
0.0 (min) to 1.0 (max)
"Bass" gain
/audioanalysis/gain/bass
0.0 (min) to 1.0 (max)
"Mid" gain
/audioanalysis/gain/mid
0.0 (min) to 1.0 (max)
"High" gain
/audioanalysis/gain/high
0.0 (min) to 1.0 (max)


Tempo

ActionOSC AddressArgument
BPM Value
/tempo/bpm
0.0 (20) to 1.0 (999)
TAP
/tempo/tap
1
Resync
/tempo/resync
1
Toggle Ableton Link
/abletonlink/toggle
1 (on) or 0 (off)

Groups

Group selection

ActionOSC AddressArgument
Select
/sequences/[seqName]/groups/[groupName]/select
/sequences/edited/groups/[n]/select
1
Select above
/sequences/edited/groups/selectabove
1
Select below
/sequences/edited/groups/selectbelow
1


Examples for a group named "Group D", in fourth position from the bottom of the list, in a sequence named "Seq 1-2":

/sequences/seq1-2/groups/groupd/select
/sequences/edited/groups/4/select

Group properties

ActionOSC AddressArgument
Opacity
/sequences/[seqName]/groups/[groupName]/opacity/[variable]
/sequences/edited/groups/[n]/opacity/[variable]
/sequences/edited/groups/selected/opacity/[variable]
Depends on [variable]


Examples for a group named "Group D", in fourth position from the bottom of the list, in a sequence named "Seq 1-2":

/sequences/seq1-2/groups/groupd/opacity/value
/sequences/edited/groups/4/opacity/value
/sequences/edited/groups/selected/opacity/value

/sequences/seq1-2/groups/groupd/opacity/lfo/mode
/sequences/seq1-2/groups/groupd/opacity/lfo/min
/sequences/seq1-2/groups/groupd/opacity/lfo/max
/sequences/seq1-2/groups/groupd/opacity/lfo/tempo
/sequences/seq1-2/groups/groupd/opacity/lfo/speed
...

Group shaders

ActionOSC AddressArgument
Toggle all (2.13.5)
/sequences/[seqName]/groups/[groupName]/shaders/all/toggle
/sequences/edited/groups/[n]/shaders/all/toggle
/sequences/edited/groups/selected/shaders/all/toggle
1 (on) or 0 (off)
Toggle one
/sequences/[seqName]/groups/[groupName]/shaders/[shaderName]/toggle
/sequences/edited/groups/[n]/shaders/[shaderName]/toggle
/sequences/edited/groups/selected/shaders/[shaderName]/toggle
/sequences/[seqName]/groups/[groupName]/shaders/[n]/toggle
/sequences/edited/groups/[n]/shaders/[n]/toggle
/sequences/edited/groups/selected/shaders/[n]/toggle
1 (on) or 0 (off)
Parameters
// Color parameters
/sequences/[seqName]/groups/[groupName]/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/edited/groups/[n]/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/edited/groups/selected/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/[seqName]/groups/[groupName]/shaders/[n]/[parameterName]/[colorVariable]
/sequences/edited/groups/[n]/shaders/[n]/[parameterName]/[colorVariable]
/sequences/edited/groups/selected/shaders/[n]/[parameterName]/[colorVariable]

// Other parameters
/sequences/[seqName]/groups/[groupName]/shaders/[shaderName]/[parameterName]/[variable]
/sequences/edited/groups/[n]/shaders/[shaderName]/[parameterName]/[variable]
/sequences/edited/groups/selected/shaders/[shaderName]/[parameterName]/[variable]
/sequences/[seqName]/groups/[groupName]/shaders/[n]/[parameterName]/[variable]
/sequences/edited/groups/[n]/shaders/[n]/[parameterName]/[variable]
/sequences/edited/groups/selected/shaders/[n]/[parameterName]/[variable]
Depends on [variable] or [colorVariable]


Examples for a group named "Group D", in fourth position from the bottom of the list, in a sequence named "Seq 1-2", with Chroma Zoom.fs, in second position from the bottom of its list:

/sequences/seq1-2/groups/groupd/shaders/chromazoom/toggle
/sequences/edited/groups/4/shaders/chromazoom/toggle
/sequences/edited/groups/selected/shaders/chromazoom/toggle
/sequences/seq1-2/groups/groupd/shaders/2/toggle
/sequences/edited/groups/4/shaders/2/toggle
/sequences/edited/groups/selected/shaders/2/toggle

/sequences/seq1-2/groups/groupd/shaders/chromazoom/master_zoom/value
/sequences/seq1-2/groups/groupd/shaders/chromazoom/master_zoom/lfo/mode
/sequences/seq1-2/groups/groupd/shaders/chromazoom/master_zoom/lfo/min
/sequences/seq1-2/groups/groupd/shaders/chromazoom/master_zoom/lfo/max
/sequences/seq1-2/groups/groupd/shaders/chromazoom/master_zoom/lfo/tempo
/sequences/seq1-2/groups/groupd/shaders/chromazoom/master_zoom/lfo/speed
...

Group effects

ActionOSC AddressArgument
Toggle effect
// Addresses follow this structure:
// /sequences/edited/groups/selected/[effectType]/[effectTab]/toggle
/sequences/edited/groups/selected/outline/border/toggle
/sequences/edited/groups/selected/outline/line/toggle
/sequences/edited/groups/selected/filling/color/toggle
/sequences/edited/groups/selected/filling/special/toggle
/sequences/edited/groups/selected/filling/snake/toggle
/sequences/edited/groups/selected/transformation/rotation/toggle
/sequences/edited/groups/selected/transformation/structure/toggle
1 (on) or 0 (off)
Select mode
// Addresses follow this structure:
// /sequences/edited/groups/selected/[effectType]/[effectTab]/[effectMode]/select

// Border
/sequences/edited/groups/selected/outline/border/basic/select
/sequences/edited/groups/selected/outline/border/blinking/select
/sequences/edited/groups/selected/outline/border/half/select
/sequences/edited/groups/selected/outline/border/quarter/select

// Line
/sequences/edited/groups/selected/outline/line/normal/select
/sequences/edited/groups/selected/outline/line/boomerang/select
/sequences/edited/groups/selected/outline/line/yoyo/select

// Color
/sequences/edited/groups/selected/filling/color/normal/select
/sequences/edited/groups/selected/filling/color/gradientlinear/select
/sequences/edited/groups/selected/filling/color/gradientradial/select
/sequences/edited/groups/selected/filling/color/gradientangular/select
/sequences/edited/groups/selected/filling/color/gradientdiamond/select
/sequences/edited/groups/selected/filling/color/random/select

// Special
/sequences/edited/groups/selected/filling/special/inside/select
/sequences/edited/groups/selected/filling/special/outside/select
/sequences/edited/groups/selected/filling/special/corner/select
/sequences/edited/groups/selected/filling/special/swipe/select
/sequences/edited/groups/selected/filling/special/swipeglobal/select
/sequences/edited/groups/selected/filling/special/stairs/select
/sequences/edited/groups/selected/filling/special/hypnotic/select
/sequences/edited/groups/selected/filling/special/stripes/select
/sequences/edited/groups/selected/filling/special/doublestripes/select
/sequences/edited/groups/selected/filling/special/mosaic/select

// Structure
/sequences/edited/groups/selected/transformation/structure/radialglow/select
/sequences/edited/groups/selected/transformation/structure/wireframe/select
/sequences/edited/groups/selected/transformation/structure/roundtrip/select
/sequences/edited/groups/selected/transformation/structure/strokes/select
/sequences/edited/groups/selected/transformation/structure/origami/select
/sequences/edited/groups/selected/transformation/structure/elastic/select
1
Border parameters
// Color (2.13)
/sequences/edited/groups/selected/outline/border/basic/color/[colorVariable]

// Thickness
/sequences/edited/groups/selected/outline/border/basic/thickness/[variable]

// Speed
/sequences/edited/groups/selected/outline/border/blinking/speed/[variable]
/sequences/edited/groups/selected/outline/border/blinking/speed/phaseoffset/value

// Duplications
/sequences/edited/groups/selected/outline/border/basic/duplication/number
/sequences/edited/groups/selected/outline/border/blinking/duplication/inneroffset/value

// Depth
/sequences/edited/groups/selected/outline/border/basic/depth/[variable]
/sequences/edited/groups/selected/outline/border/basic/perspective/scalestroke
/sequences/edited/groups/selected/outline/border/basic/perspective/none

// Path
/sequences/edited/groups/selected/outline/border/basic/origin/default
/sequences/edited/groups/selected/outline/border/basic/origin/center
Depends on [variable] or [colorVariable]
Line parameters
// Color (2.13)
/sequences/edited/groups/selected/outline/line/normal/color/[colorVariable]

// Thickness
/sequences/edited/groups/selected/outline/line/normal/thickness/[variable]

// Fade
/sequences/edited/groups/selected/outline/line/normal/fade/[variable]

// Length
/sequences/edited/groups/selected/outline/line/normal/length/[variable]
/sequences/edited/groups/selected/outline/line/normal/dash/number

// Speed
/sequences/edited/groups/selected/outline/line/normal/speed/[variable]
/sequences/edited/groups/selected/outline/line/normal/speed/phaseoffset/value

// Duplications
/sequences/edited/groups/selected/outline/line/normal/duplication/number
/sequences/edited/groups/selected/outline/line/normal/duplication/inneroffset/value

// Depth
/sequences/edited/groups/selected/outline/line/normal/depth/[variable]
/sequences/edited/groups/selected/outline/line/normal/perspective/scalestroke
/sequences/edited/groups/selected/outline/line/normal/perspective/none

// Path
/sequences/edited/groups/selected/outline/line/normal/direction/left
/sequences/edited/groups/selected/outline/line/normal/direction/right
/sequences/edited/groups/selected/outline/line/normal/origin/default
/sequences/edited/groups/selected/outline/line/normal/origin/center
Depends on [variable] or [colorVariable]
Color parameters
// Color (2.13)
/sequences/edited/groups/selected/filling/color/plain/color/[colorVariable]
/sequences/edited/groups/selected/filling/color/gradient/color1/[colorVariable]
/sequences/edited/groups/selected/filling/color/gradient/color2/[colorVariable]
/sequences/edited/groups/selected/filling/color/random/color/[n]/[colorVariable]
with [n] being the position of the color in the list starting from the top

// Motion - Direction
/sequences/edited/groups/selected/filling/gradient/none/direction1 //for "None" Motion mode
/sequences/edited/groups/selected/filling/gradient/swing/direction1 //for "Swing" & "Blink" Motion modes
/sequences/edited/groups/selected/filling/gradient/swing/direction2 //for "Swing" & "Blink" Motion modes
/sequences/edited/groups/selected/filling/gradient/direction/left //for "Rotate" Motion mode
/sequences/edited/groups/selected/filling/gradient/direction/right //for "Rotate" Motion mode

// Motion - Speed
/sequences/edited/groups/selected/filling/gradient/rotatespeed/value

// Motion - Phase Offset
/sequences/edited/groups/selected/filling/gradient/none/phaseoffset/value

// Random - Transitions
/sequences/edited/groups/selected/filling/color/random/transition/smooth
/sequences/edited/groups/selected/filling/color/random/transition/none
Depends on [variable] or [colorVariable]
Special parameters
// Color (2.13)
/sequences/edited/groups/selected/filling/special/inside/color/[colorVariable]

// Fill Percentage
/sequences/edited/groups/selected/filling/special/inside/fill/[variable]
/sequences/edited/groups/selected/filling/special/inside/fill/phaseoffset/value

// Speed
/sequences/edited/groups/selected/filling/hypnotic/speed/[variable]
/sequences/edited/groups/selected/filling/special/doublestripes/speed2/[variable]
/sequences/edited/groups/selected/filling/special/inside/fill/phaseoffset/value

// Fade
/sequences/edited/groups/selected/filling/special/inside/fade/[variable]

// Width
/sequences/edited/groups/selected/filling/special/doublestripes/width1/[variable]
/sequences/edited/groups/selected/filling/special/doublestripes/width2/[variable]

// Spacing
/sequences/edited/groups/selected/filling/special/doublestripes/spacing1/[variable]
/sequences/edited/groups/selected/filling/special/doublestripes/spacing2/[variable]

// Path
/sequences/edited/groups/selected/filling/special/inside/origin/center
/sequences/edited/groups/selected/filling/special/inside/origin/default
/sequences/edited/groups/selected/filling/special/stripes/direction
/sequences/edited/groups/selected/filling/special/doublestripes/direction2/
Depends on [variable] or [colorVariable]
Snake parameters
// Apply on
/sequences/edited/groups/selected/filling/snake/color/checkbox
/sequences/edited/groups/selected/filling/snake/special/checkbox

// Path
/sequences/edited/groups/selected/filling/snake/direction/left
/sequences/edited/groups/selected/filling/snake/direction/right

// Step
/sequences/edited/groups/selected/filling/snake/step/sustain/[variable]
/sequences/edited/groups/selected/filling/snake/step/release/[variable]

// Speed
/sequences/edited/groups/selected/filling/snake/speed/value
Depends on [variable]
Rotation parameters
// Path
/sequences/edited/groups/selected/transformation/rotation/path/axisx
/sequences/edited/groups/selected/transformation/rotation/path/axisy
/sequences/edited/groups/selected/transformation/rotation/path/axisz
/sequences/edited/groups/selected/transformation/rotation/direction/left
/sequences/edited/groups/selected/transformation/rotation/direction/right
/sequences/edited/groups/selected/transformation/rotation/origin/center
/sequences/edited/groups/selected/transformation/rotation/origin/default

// Speed
/sequences/edited/groups/selected/transformation/rotation/speed/value
/sequences/edited/groups/selected/transformation/rotation/phaseoffset/value
Depends on [variable]
Structure parameters
// Color (2.13)
/sequences/edited/groups/selected/transformation/structure/radialglow/color/[colorVariable]

// Type
/sequences/edited/groups/selected/transformation/structure/elastic/motion/rotate
/sequences/edited/groups/selected/transformation/structure/elastic/motion/swing
/sequences/edited/groups/selected/transformation/structure/elastic/motion/scale
/sequences/edited/groups/selected/transformation/structure/elastic/link/none
/sequences/edited/groups/selected/transformation/structure/elastic/link/line

// Thickness
/sequences/edited/groups/selected/transformation/structure/radialglow/thickness/[variable]

// Depth
/sequences/edited/groups/selected/transformation/structure/roundtrip/depth/[variable]

// Speed
/sequences/edited/groups/selected/transformation/structure/radialglow/speed/[variable]
/sequences/edited/groups/selected/transformation/structure/radialglow/phaseoffset/value

// Instances
/sequences/edited/groups/selected/transformation/structure/radialglow/instances/number
/sequences/edited/groups/selected/transformation/structure/radialglow/instances/multiplier

// Path
/sequences/edited/groups/selected/transformation/structure/wireframe/direction/left
/sequences/edited/groups/selected/transformation/structure/wireframe/direction/right
/sequences/edited/groups/selected/transformation/structure/radialglow/origin/default
/sequences/edited/groups/selected/transformation/structure/radialglow/origin/center
Depends on [variable] or [colorVariable]

Shapes

Coordinates

ActionOSC AddressArgument
X coordinate (shape)
/sequences/edited/shapes/selected/x/value
/maps/[mapName]/shapes/[shapeName]/x/value
Depends on [variable]
Y coordinate (shape)
/sequences/edited/shapes/selected/y/value
/maps/[mapName]/shapes/[shapeName]/y/value
Depends on [variable]
X coordinate (vertex)
/sequences/edited/vertex/selected/x/value
/maps/[mapName]/shapes/[shapeName]/vertex/[vertexName]/x/value
Depends on [variable]
Y coordinate (vertex)
/sequences/edited/vertex/selected/y/value
/maps/[mapName]/shapes/[shapeName]/vertex/[vertexName]/y/value
Depends on [variable]
X coordinate (center)
/sequences/edited/shapes/selected/center/x/[variable]
Depends on [variable]
Y coordinate (center)
/sequences/edited/shapes/selected/center/y/[variable]
Depends on [variable]


Examples for a shape named "Player 2", with a vertex named "Vertex 192", in a map named "Map 1-2":

/sequences/edited/shapes/selected/x/value
/maps/map1-2/shapes/player2/x/value

/sequences/edited/shapes/selected/y/value
/maps/map1-2/shapes/player2/y/value

/sequences/edited/vertex/selected/x/value
/maps/map1-2/shapes/player2/vertex/vertex192/x/value

/sequences/edited/vertex/selected/y/value
/maps/map1-2/shapes/player2/vertex/vertex192/y/value

/sequences/edited/shapes/selected/center/x/value
/sequences/edited/shapes/selected/center/x/lfo/mode
/sequences/edited/shapes/selected/center/x/lfo/min
/sequences/edited/shapes/selected/center/x/lfo/max
/sequences/edited/shapes/selected/center/x/lfo/tempo
/sequences/edited/shapes/selected/center/x/lfo/speed

/sequences/edited/shapes/selected/center/y/value
/sequences/edited/shapes/selected/center/y/lfo/mode
/sequences/edited/shapes/selected/center/y/lfo/min
/sequences/edited/shapes/selected/center/y/lfo/max
/sequences/edited/shapes/selected/center/y/lfo/tempo
/sequences/edited/shapes/selected/center/y/lfo/speed

Dimensions

ActionOSC AddressArgument
Width (shape)
/sequences/edited/shapes/selected/w/value
/maps/[mapName]/shapes/[shapeName]/w/value
Depends on [variable]
Height (shape)
/sequences/edited/shapes/selected/h/value
/maps/[mapName]/shapes/[shapeName]/h/value
Depends on [variable]


Examples for a shape named "Player 2", in a map named "Map 1-2":

/sequences/edited/shapes/selected/w/value
/maps/map1-2/shapes/player2/w/value

/sequences/edited/shapes/selected/h/value
/maps/map1-2/shapes/player2/h/value

Player shaders

ActionOSC AddressArgument
Toggle all
/sequences/[seqName]/shapes/[playerName]/shaders/all/toggle
/sequences/edited/shapes/[playerName]/shaders/all/toggle
1 (on) or 0 (off)
Toggle one
/sequences/[seqName]/shapes/[playerName]/shaders/[shaderName]/toggle
/sequences/edited/shapes/[playerName]/shaders/[shaderName]/toggle
/sequences/[seqName]/shapes/[playerName]/shaders/[n]/toggle
/sequences/edited/shapes/[playerName]/shaders/[n]/toggle
1 (on) or 0 (off)
Parameters
// Color parameters
/sequences/[seqName]/shapes/[playerName]/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/edited/shapes/[playerName]/shaders/[shaderName]/[parameterName]/[colorVariable]
/sequences/[seqName]/shapes/[playerName]/shaders/[n]/[parameterName]/[colorVariable]
/sequences/edited/shapes/[playerName]/shaders/[n]/[parameterName]/[colorVariable]

// Other parameters
/sequences/[seqName]/shapes/[playerName]/shaders/[shaderName]/[parameterName]/[variable]
/sequences/edited/shapes/[playerName]/shaders/[shaderName]/[parameterName]/[variable]
/sequences/[seqName]/shapes/[playerName]/shaders/[n]/[parameterName]/[variable]
/sequences/edited/shapes/[playerName]/shaders/[n]/[parameterName]/[variable]
Depends on [variable] or [colorVariable]


Examples for a player named "Player 2", in a sequence named "Seq 1-2", with Chroma Zoom.fs, in second position from the bottom of its list:

/sequences/seq1-2/shapes/player2/shaders/chromazoom/toggle
/sequences/edited/shapes/player2/shaders/chromazoom/toggle
/sequences/seq1-2/shapes/player2/shaders/2/toggle
/sequences/edited/shapes/player2/shaders/2/toggle

/sequences/seq1-2/shapes/player2/shaders/chromazoom/master_zoom/value
/sequences/seq1-2/shapes/player2/shaders/chromazoom/master_zoom/lfo/mode
/sequences/seq1-2/shapes/player2/shaders/chromazoom/master_zoom/lfo/min
/sequences/seq1-2/shapes/player2/shaders/chromazoom/master_zoom/lfo/max
/sequences/seq1-2/shapes/player2/shaders/chromazoom/master_zoom/lfo/tempo
/sequences/seq1-2/shapes/player2/shaders/chromazoom/master_zoom/lfo/speed
...

Sources

Playback

ActionOSC AddressArgument
Playback mode
/sources/[n]/playbackmode
0.0 Normal
0.5 Restart
1.0 Skip (only playlists)
Toggle "Restart with sequence"
/sources/[n]/restartwithseq
1 (on) or 0 (off)
Trigger media
/sources/[n]/medias/[n]/trigger // for playlist sources
1
Trigger next media
/sources/[n]/next // for playlist sources
1
Trigger previous media
/sources/[n]/previous // for playlist sources
1
Restart playlist
/sources/[n]/restart // for playlist sources
1
Media loop mode
/sources/[n]/loop // for solo sources
/sources/[n]/medias/[n]/loop // for playlist sources
0.0 Loop
0.33 Follow (only playlist)
0.66 Pause
1.0 Stop


Examples for a solo source in 1st position from the top left:

/sources/1/playbackmode
/sources/1/restartwithseq
/sources/1/loop

Examples for a playlist source in 2nd position from the top left, with at least 2 medias:

/sources/2/playbackmode
/sources/2/restartwithseq
/sources/2/medias/2/trigger
/sources/2/next
/sources/2/previous
/sources/2/restart
/sources/2/loop
/sources/2/medias/2/loop

Video

ActionOSC AddressArgument
Play / Pause
/sources/[n]/play // for solo sources
/sources/[n]/medias/[n]/play // for playlist sources
1 (play) or 0 (pause)
Rewind
/sources/[n]/rewind // for solo sources
/sources/[n]/medias/[n]/rewind // for playlist sources
1
Volume
/sources/[n]/volume // for solo sources
/sources/[n]/medias/[n]/volume // for playlist sources
0.0 (mute) to 1.0 (max)

Examples for a solo video source in 1st position from the top left:

/sources/1/play
/sources/1/rewind
/sources/1/volume

Examples for a playlist source in 2nd position from the top left, with a video in 1st media position:

/sources/2/play
/sources/2/rewind
/sources/2/medias/1/volume

Shader

ActionOSC AddressArgument
Parameters
// Color parameters
/sources/[n]/[parameterName]/[colorVariable] // for solo sources
/sources/[n]/medias/[n]/[parameterName]/[colorVariable] // for playlist sources

// Other parameters
/sources/[n]/[parameterName]/[variable] // for solo sources
/sources/[n]/medias/[n]/[parameterName]/[variable] // for playlist sources
Depends on [variable] or [colorVariable]

Examples for Bricked.fs in a solo shader source, in 1st position from the top left:

/sources/1/tile/value
/sources/1/tile/lfo/mode
...

Examples for a playlist source in 2nd position from the top left, with Bricked.fs in 1st media position:

/sources/2/medias/1/tile/value
/sources/2/medias/1/tile/lfo/mode
...

Text

ActionOSC AddressArgument
Parameters
/sources/[n]/align // for solo sources
/sources/[n]/medias/[n]/align // for playlist sources
0.0 Left
0.5 Center
1.0 Right

Example for a solo text source in 1st position from the top left:

/sources/1/align

Example for a playlist source in 2nd position from the top left, with a text in 1st media position:

/sources/2/medias/1/align

Cet article a-t-il été utile ?

C'est super !

Merci pour votre commentaire

Désolé ! Nous n'avons pas pu vous être utile

Merci pour votre commentaire

Dites-nous comment nous pouvons améliorer cet article !

Sélectionner au moins l'une des raisons
La vérification CAPTCHA est requise.

Commentaires envoyés

Nous apprécions vos efforts et nous allons corriger l'article