Admin at 20:38, 11 April 2024

2024-04-11T20:38:19Z

← Older revision		Revision as of 20:38, 11 April 2024
Line 71:		Line 71:
	\|-		\|-
	\| <code>/mxw/playlist info</code> \|\| return information on the state of the playback of playlist\|\| <code>"info"</code>		\| <code>/mxw/playlist info</code> \|\| return information on the state of the playback of playlist\|\| <code>"info"</code>
			\|-
			\| <code>/mxw/playlist select</code> \|\| jump to cue by name \|\| <code>"select" "cuename"</code>
	\|-		\|-
	\| <code>/mxw/playlist/gotostart</code> \|\| stop and go to first track on list<ref>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.</ref>\|\| <code>0</code>		\| <code>/mxw/playlist/gotostart</code> \|\| stop and go to first track on list<ref>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.</ref>\|\| <code>0</code>

Admin at 18:57, 21 February 2023

2023-02-21T18:57:30Z

← Older revision		Revision as of 18:57, 21 February 2023
Line 82:		Line 82:
	\| <code>/mxw/playlist/gotonext</code> \|\| go to next cue\|\| <code>0</code>		\| <code>/mxw/playlist/gotonext</code> \|\| go to next cue\|\| <code>0</code>
	\|-		\|-
	\| <code>/mxw/playlist/gotocueandplay</code> \|\| go to a specific cue and immediately play\|\| <code>0</code>		\| <code>/mxw/playlist/gotocueandplay</code> \|\| go to a specific cue and immediately play\|\| <code>0..n (MAX n rows)</code>
	\|-		\|-
	\| <code>/mxw/playlist/gotocue</code> \|\| go to a specific cue\|\| <code>0</code>		\| <code>/mxw/playlist/gotocue</code> \|\| go to a specific cue\|\| <code>0..n (MAX n rows)</code>
	\|-		\|-
	\| <code>/mxw/playlist/container/active</code> \|\| info about the total playlist container\|\| <code>"info"</code>		\| <code>/mxw/playlist/container/active</code> \|\| info about the total playlist container\|\| <code>"info"</code>

Hendrik: /* Variables */

2022-10-24T09:13:54Z

Variables

← Older revision		Revision as of 09:13, 24 October 2022
Line 4:		Line 4:
	<div>		<div>
	==== Variables ====		==== Variables ====
	When ~~variable~~ are found ~~inside~~ the address of a command ( and not only as the value to be sent), the <code>$+index</code> notation has been employed :		When variables are found in the address of a command ( and not only as the value to be sent), the <code>$+index</code> notation has been employed :

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

	<code>/mxw/track/2 0.5 </code>		<code>/mxw/track/2 0.5 </code>

	~~will be used.~~
	==== Values ====		==== Values ====
	The standard used to represent the available values for each command (column “RANGE or TOKEN”) is:		The standard used to represent the available values for each command (column “RANGE or TOKEN”) is:

Hendrik: Created page with "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..."

2022-03-10T11:37:36Z

Created page with "Here are listed all the commands that MXW recognizes. === Legend === <div> ==== Variables ==== When variable are found inside the address of a command ( and not only as the..."

New page

Here are listed all the commands that MXW recognizes.

=== Legend ===
<div>
==== Variables ====
When variable are found inside the address of a command ( and not only as the value to be sent), the <code>$+index</code> notation has been employed :

<code>/mxw/track/$1 [value] </code> indicates that a variable <code>$1</code> 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:

<code>/mxw/track/2 0.5 </code>

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:

<code>0.0 .. 1.0</code> → all float values between 0 and 1 included

''INTEGERS'' are represented with numbers or descriptions:

<code>1 .. 5</code> → all integers between 1 and 5 included ( 1 , 2 , 3 , 4 , 5 ) 
<code>1 .. (MAX n layers)</code> → 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:

<code>“info”</code> 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

<code>/mxw/set info </code>

would be sent.

When <code>“name”</code> 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 <code>/mxw/set</code> with tokens <code>"play" "name_of_patch"</code> has to be used, resulting in this OSC command:

<code>/mxw/set play patch_one</code>

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===

{| class="wikitable"
|-
! OSC ADDRESS !! DESCRIPTION !! RANGE or TOKEN
|-
|<code> /mxw/set</code>||get information on the patches|| <code>“info”</code>
|-
| <code>/mxw/set</code>||play a specific patch|| <code>“play” “name_of_patch”</code>
|-
| <code>/mxw/set</code>||choose a patch|| <code>1 .. (MAX n patches)</code>
|-
| <code>/mxw/editor</code>||choose UI tab|| <code>0 .. 5</code>
|-
| <code>/mxw/trackmanager</code>||choose active track || <code>0.0 .. 1.0</code> OR <code>1 .. 4</code>
|-
| <code>/mxw/trackmanager</code>||clear all tracks || <code>"clear"</code>
|-
| <code>/mxw/layermanager</code> ||choose active layer || <code>1 .. (MAX n layers)</code>
|-
| <code>/mxw/layermanager</code>||clear layers in active track|| <code>"clear"</code>
|-
| <code>/mxw/beatbutton</code> || Send pulse to beat-button (BPM)|| <code>1</code>
|-
| <code>/mxw/playlist info</code> || return information on the state of the playback of playlist|| <code>"info"</code>
|-
| <code>/mxw/playlist/gotostart</code> || stop and go to first track on list<ref>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.</ref>|| <code>0</code>
|-
| <code>/mxw/playlist/gotoprev</code> || go to previous cue|| <code>0</code>
|-
| <code>/mxw/playlist/play</code> || play active item|| <code>0</code>
|-
| <code>/mxw/playlist/pause</code> || pause active playing clip|| <code>0</code>
|-
| <code>/mxw/playlist/gotonext</code> || go to next cue|| <code>0</code>
|-
| <code>/mxw/playlist/gotocueandplay</code> || go to a specific cue and immediately play|| <code>0</code>
|-
| <code>/mxw/playlist/gotocue</code> || go to a specific cue|| <code>0</code>
|-
| <code>/mxw/playlist/container/active</code> || info about the total playlist container|| <code>"info"</code>
|-
| <code>/mxw/playlist/container/active/column/$1/row/$2</code> || info about the selected field in the playlist grid|| $1 → <code>0 .. (MAX n columns)</code> $2 → <code>1 .. (MAX n rows)</code> <code>"info"</code>
|-
| <code>/mxw/set/first</code> || go to first patch on the list|| <code>0</code>
|-
| <code>/mxw/set/prev</code> || select the previous patch || <code>0</code>
|-
| <code>/mxw/set/play</code> || play selected patch <ref>The button play in the patch tab works like the play button in the MXW playlist GUI, every click will play the following patch.</ref>|| <code>0</code>
|-
| <code>/mxw/set/next</code>|| select to next patch|| <code>0</code>
|-
| <code>/mxw/set</code>|| clear all patches || <code>"clear"</code>
|-
| <code>/mxw/render</code>|| change of render opacity|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/opacity</code>|| change of render opacity|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/scale</code>|| change of render scale|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/scalexy</code>|| change of render scale ratio|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/translationx</code>|| change of render position x|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/translationy</code>|| change of render position y|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/rotation</code>|| change of render rotation|| <code>0.0 .. 1.0</code>
|-
| <code>/mxw/render/reset</code>|| reset render changes|| <code>0</code>
|-
| <code>/mxw/render/effect</code>|| selects wished render fx|| <code>1 .. (MAX n fx)
</code>
|-
| <code>/mxw/render/effect/1/param/$1 </code>|| modifies value of one parameter($1) of the render fx|| $1→ <code>1 .. (MAX n parameters)</code> 
VALUE → <code>0.0 .. 1.0</code>
|-
| <code>/mxw/track/$1</code>|| set opacity value of a specific track ($1)|| $1 → <code>1 .. 4</code>
VALUE → <code>0.0 .. 1.0</code>
|-
| <code>/mxw/track/active</code>|| change opacity of active track moving the fader|| <code>0.0 .. 1.0
</code>
|-
| <code>/mxw/track/active/fader</code>|| change opacity of active track moving the fader|| <code>0.0 .. 1.0
</code>
|-
| <code>/mxw/track/active/crossfader</code>|| activates the crossfading between tracks|| <code>0.0 (OFF) OR 1.0 (ON)</code>
|-
| <code>/mxw/track/active/mode</code>|| changes the mode of fading|| <code>1 .. 8</code>
|-
| <code>/mxw/preload/$1/trigger</code>|| trigger preload $1 content to current track|| $1 → <code>1 .. (MAX n preloads)</code>
VALUE → <code>0</code>
|-
| <code>/mxw/preload/$1/flipflop</code>|| flipflop preload $1 content to current track|| $1 → <code>1 .. (MAX n preloads)</code>
VALUE → <code>0</code>
|-
| <code>/mxw/track/active/layer/active/clip/play</code> || toggles play-pause button of live editor || <code>0</code>
|-
| <code>/mxw/track/active/layer/active/scale</code> || change of layer scale || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/scalexy</code> || change of layer scale ratio || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/translationx</code> || change of layer position x || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/translationy</code> || change of layer position y || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/rotation</code> || change of layer rotation || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/mode</code> || change of layer blend mode || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/aspectmode</code> || change of layer aspect mode || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/reset</code> || reset layer changes || <code>0</code>
|-
| <code>/mxw/track/active/layer/active/clip/keyin</code> || set keyin of clip of active layer || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/keyout</code> || set keyout of clip of active layer || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/speed</code> || set speed of clip of active layer <ref> 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. </ref> || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/position</code> || set position of clip of active layer || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/mode</code> || set mode of clip of active layer || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect</code> || choose active effect || <code>0 .. (MAX n of fx)</code>
|-
| <code>/mxw/track/active/layer/active/clip/effectbank</code> || selects active effect || <code>0 .. (MAX n of fx)</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/active/param/$1</code> || set param $1 of effect || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/1/color/1/red</code> || set red component of color param. || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/1/color/1/green</code> || set green component param. || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/1/color/1/blue</code> || set blue component param. || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/1/color/1/hue</code> || set huecomponent param. || <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/1/color/1/saturation</code> || set saturation | <code>0 .. 1</code>
|-
| <code>/mxw/track/active/layer/active/clip/effect/1/color/1/value</code> || set value component param. || <code>0 .. 1</code>
|-
| <code>/mxw/keystone/element/$1/pivot/col/$2/row/$3/xposition</code> || move keystone pivot in x || $1 → <code>1 .. (MAX n elements)</code>
$2 (COLUMN) → <code>1 OR 2</code>
$3 (ROW) → <code>1 OR 2</code>
VALUE → <code>0 .. 1</code>
|-
| <code>/mxw/keystone/element/$1/pivot/col/$2/row/$3/yposition</code> || move keystone pivot in y|| $1 → <code>1 .. (MAX n elements)</code>
$2 (COLUMN) → <code>1 OR 2</code>
$3 (ROW) → <code>1 OR 2</code>
VALUE → <code>0 .. 1</code>
|-
| <code>/mxw/keystone_io_animator</code> || keystone io animator fader|| <code>0 .. 1</code>
|-
|}

3. MXW OSC command reference - Revision history

Admin at 20:38, 11 April 2024

Admin at 18:57, 21 February 2023

Hendrik: /* Variables */

Hendrik: Created page with "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..."

Hendrik: Created page with "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..."