3. MXW OSC command reference

From MXWendler Wiki
(Redirected from 3. MXW OSC set reference)
Jump to navigation Jump to search

Here are listed all the commands that MXW recognizes.

Legend

Variables

When variable are found inside the address of a command ( and not only as the value to be sent), the $+index notation has been employed :

/mxw/track/$1 [value] indicates that a variable $1 has to be chosen and will specify the correct address where the value will be sent.
In this example, if the goal is for example to reduce of 50% the opacity of the 2nd track, the command:

/mxw/track/2 0.5

will be used.

Values

The standard used to represent the available values for each command (column “RANGE or TOKEN”) is:


FLOATS are represented with one decimal:

0.0 .. 1.0 → all float values between 0 and 1 included


INTEGERS are represented with numbers or descriptions:

1 .. 5 → all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 )
1 .. (MAX n layers) → all the integers between 1 and the maximum index of layers in MXW (e.g. if 6 layers are being used the values are integers between 1 and 6 included)

When only one number is indicated it means that only one option is given. This is found in addresses of buttons, checkboxes and in the options where "0" or "1" are the only significant values


STRINGS are represented between quotation marks:

“info” means that the string info has to be used at the end of the command

E.G. to ask for information about the patches the command

/mxw/set info

would be sent.

When “name” is contained in the available string variable, then the content is to be substituted with the actual name.

E.G. : to select and play a patch called “patch_one” from its name, the address /mxw/set with tokens "play" "name_of_patch" has to be used, resulting in this OSC command:

/mxw/set play patch_one


When OR is found it means that two options can deliver a similar result. One of the two formats has to be used at one time.

Set Reference

OSC ADDRESS DESCRIPTION RANGE or TOKEN
/mxw/set get information on the patches “info”
/mxw/set play a specific patch “play” “name_of_patch”
/mxw/set choose a patch 1 .. (MAX n patches)
/mxw/editor choose UI tab 0 .. 5
/mxw/trackmanager choose active track 0.0 .. 1.0 OR 1 .. 4
/mxw/trackmanager clear all tracks "clear"
/mxw/layermanager choose active layer 1 .. (MAX n layers)
/mxw/layermanager clear layers in active track "clear"
/mxw/beatbutton Send pulse to beat-button (BPM) 1
/mxw/playlist info return information on the state of the playback of playlist "info"
/mxw/playlist/gotostart stop and go to first track on list[1] 0
/mxw/playlist/gotoprev go to previous cue 0
/mxw/playlist/play play active item 0
/mxw/playlist/pause pause active playing clip 0
/mxw/playlist/gotonext go to next cue 0
/mxw/playlist/gotocueandplay go to a specific cue and immediately play 0
/mxw/playlist/gotocue go to a specific cue 0
/mxw/playlist/container/active info about the total playlist container "info"
/mxw/playlist/container/active/column/$1/row/$2 info about the selected field in the playlist grid $1 → 0 .. (MAX n columns)
$2 → 1 .. (MAX n rows)
"info"
/mxw/set/first go to first patch on the list 0
/mxw/set/prev select the previous patch 0
/mxw/set/play play selected patch [2] 0
/mxw/set/next select to next patch 0
/mxw/set clear all patches "clear"
/mxw/render change of render opacity 0.0 .. 1.0
/mxw/render/opacity change of render opacity 0.0 .. 1.0
/mxw/render/scale change of render scale 0.0 .. 1.0
/mxw/render/scalexy change of render scale ratio 0.0 .. 1.0
/mxw/render/translationx change of render position x 0.0 .. 1.0
/mxw/render/translationy change of render position y 0.0 .. 1.0
/mxw/render/rotation change of render rotation 0.0 .. 1.0
/mxw/render/reset reset render changes 0
/mxw/render/effect selects wished render fx 1 .. (MAX n fx)

/mxw/render/effect/1/param/$1 modifies value of one parameter($1) of the render fx $1→ 1 .. (MAX n parameters)

VALUE → 0.0 .. 1.0

/mxw/track/$1 set opacity value of a specific track ($1) $1 → 1 .. 4

VALUE → 0.0 .. 1.0

/mxw/track/active change opacity of active track moving the fader 0.0 .. 1.0

/mxw/track/active/fader change opacity of active track moving the fader 0.0 .. 1.0

/mxw/track/active/crossfader activates the crossfading between tracks 0.0 (OFF) OR 1.0 (ON)
/mxw/track/active/mode changes the mode of fading 1 .. 8
/mxw/preload/$1/trigger trigger preload $1 content to current track $1 → 1 .. (MAX n preloads)

VALUE → 0

/mxw/preload/$1/flipflop flipflop preload $1 content to current track $1 → 1 .. (MAX n preloads)

VALUE → 0

/mxw/track/active/layer/active/clip/play toggles play-pause button of live editor 0
/mxw/track/active/layer/active/scale change of layer scale 0 .. 1
/mxw/track/active/layer/active/scalexy change of layer scale ratio 0 .. 1
/mxw/track/active/layer/active/translationx change of layer position x 0 .. 1
/mxw/track/active/layer/active/translationy change of layer position y 0 .. 1
/mxw/track/active/layer/active/rotation change of layer rotation 0 .. 1
/mxw/track/active/layer/active/mode change of layer blend mode 0 .. 1
/mxw/track/active/layer/active/aspectmode change of layer aspect mode 0 .. 1
/mxw/track/active/layer/active/reset reset layer changes 0
/mxw/track/active/layer/active/clip/keyin set keyin of clip of active layer 0 .. 1
/mxw/track/active/layer/active/clip/keyout set keyout of clip of active layer 0 .. 1
/mxw/track/active/layer/active/clip/speed set speed of clip of active layer [3] 0 .. 1
/mxw/track/active/layer/active/clip/position set position of clip of active layer 0 .. 1
/mxw/track/active/layer/active/clip/mode set mode of clip of active layer 0 .. 1
/mxw/track/active/layer/active/clip/effect choose active effect 0 .. (MAX n of fx)
/mxw/track/active/layer/active/clip/effectbank selects active effect 0 .. (MAX n of fx)
/mxw/track/active/layer/active/clip/effect/active/param/$1 set param $1 of effect 0 .. 1
/mxw/track/active/layer/active/clip/effect/1/color/1/red set red component of color param. 0 .. 1
/mxw/track/active/layer/active/clip/effect/1/color/1/green set green component param. 0 .. 1
/mxw/track/active/layer/active/clip/effect/1/color/1/blue set blue component param. 0 .. 1
/mxw/track/active/layer/active/clip/effect/1/color/1/hue set huecomponent param. 0 .. 1
/mxw/track/active/layer/active/clip/effect/1/color/1/saturation 0 .. 1
/mxw/track/active/layer/active/clip/effect/1/color/1/value set value component param. 0 .. 1
/mxw/keystone/element/$1/pivot/col/$2/row/$3/xposition move keystone pivot in x $1 → 1 .. (MAX n elements)

$2 (COLUMN) → 1 OR 2 $3 (ROW) → 1 OR 2 VALUE → 0 .. 1

/mxw/keystone/element/$1/pivot/col/$2/row/$3/yposition move keystone pivot in y $1 → 1 .. (MAX n elements)

$2 (COLUMN) → 1 OR 2 $3 (ROW) → 1 OR 2 VALUE → 0 .. 1

/mxw/keystone_io_animator keystone io animator fader 0 .. 1
  1. The functionality of gotostart is the same as the gotostart button in the MXW playlist GUI ( ❙❙◀ ), so the command has to be sent two times to reset the playlist at the original state.
  2. The button play in the patch tab works like the play button in the MXW playlist GUI, every click will play the following patch.
  3. The values are sent to the "speed fader", which values go between 5 and -5, they do not act directly on the "speed value". This means that depending on the active media the available values in the fader will differ.