Remote control#
All widgets that send osc messages respond to the same messages. Additionnaly, Open Stage Control responds to some general osc commands.
/EDIT id options
#
Apply a set of options to an existing widget by replacing the old ones with the new ones.
id
:string
, widget'sid
options
:string
, JSON5 stringified object defining the new properties to merge- example:
{"label":"New Label", "color":"red"}
Editing a widget can be cpu expensive, hence updating the UI continuously is not a good idea
/EDIT/MERGE id options
#
Apply a set of options to an existing widget by merging them to the widget's options.
id
:string
, widget'sid
options
:string
, JSON5 stringified object defining the new properties to merge- example:
{"label":"New Label", "color":"red"}
Editing a widget can be cpu expensive, hence updating the UI continuously is not a good idea
/EDIT/UNDO
#
Undo editing action
/EDIT/REDO
#
Redo editing action
/EDIT/GET target id
#
Sends back a widget's data (JSON stringified object), including its children, to specified target.
target
:string
,ip:port
pairid
:string
, widget'sid
Replies /EDIT/GET id data
id
:string
data
:string
/EDIT/GET target address preArg1 preArg2 ...
#
Sends back a widget's data (JSON stringified object), including its children, to specified target.
target
:string
,ip:port
pairaddress
:string
, widget'saddress
preArg[1...]
:*
, widget'spreArgs
Replies /EDIT/GET address preArg1 preArg2 ... data
address
:string
, widget'saddress
preArg[1...]
:*
, widget'spreArgs
data
:string
/GET target id
#
Sends back a widget's value to specified target.
target
:string
,ip:port
pairid
:string
, widget'sid
Replies /GET id value
id
:string
value
:*
/GET target address preArg1 preArg2 ...
#
Sends back a widget's value to specified target.
target
:string
,ip:port
pairaddress
:string
, widget'saddress
preArg[1...]
:*
, widget'spreArgs
Replies /GET address preArg1 preArg2 ... value
address
:string
, widget'saddress
preArg[1...]
:*
, widget'spreArgs
value
:*
/GET/#
#
Same as /GET
but uses the widget's address instead of /GET
to reply.
/SET target id value
#
Set a widget's value as if it was interacted with from the interface. This is likely to make it send its value.
id
:string
, widget'sid
value
:*
, widget's new value
/SET address preArg1 preArg2 ... value
#
Set a widget's value as if it was interacted with from the interface. This is likely to make it send its value.
address
:string
, widget'saddress
preArg[1...]
:*
, widget'spreArgs
value
:*
, widget's new value
/STATE/GET target
#
Sends back the app's state to specified target
target
:string
,ip:port
pair
/STATE/SET state
#
Set widgets' state
state
:string
, json stringified object ("widget_id": value
pairs)
/STATE/STORE
#
Save the state of all widgets in the temporary slot.
/STATE/RECALL
#
Reload saved state from the temporary slot.
/TABS id id etc
#
Open the tabs designated by the id
parameters.