Differences

This shows you the differences between two versions of the page.

--- reference:remote_control_commands [2021/02/17 10:30] – tondose
+++ reference:remote_control_commands [2024/03/08 09:50] – Ergänzung tondose
@@ Line 7: / Line 7: @@
 Note that some commands do not work with previous versions of mAirList.
+===== Global Settings =====
+==== On Air ====
+Please see [[reference:remote_control_commands#Encoder|Encoder section]] for special Encoder settings.
+  * ''OFF AIR'' - Leave On Air Mode.
+  * ''ON/OFF AIR'' - Toggle ''ON AIR'' and ''OFF AIR''.
+  * ''ON AIR'' - Incorporate On Air Mode.
+==== System ====
+  * ''SLEEP <Value>'' - Can be used in connected commands ("chains") to have a pause of ''<Value>'' (in milliseconds) between two or more commands.
+  * ''RUNSCRIPT '<Path>' '' - Runs a script located at ''<Path>'' (with ''<Path>'' = ''C:\Path\to\Script.mls'' or the like).
 ===== Playlist =====
@@ Line 42: / Line 58: @@
   * ''PLAYLIST 1 APPEND <Filename>'' - Append a playlist file.
   * ''PLAYLIST 1 SAVE <Filename>'' - Save to playlist file.
+  * ''PLAYLIST 1 SAVEAS <C:\path\to\file.mlp> Save to a defined file (whose format must be valid).
   * ''PLAYLIST 1 INSERTFILE <Filename>'' - Insert an audiofile after the current item.
   * ''PLAYLIST 1 ADDID <Database ID>'' - Add a database item with the respective Database ID to the end of playlist.
@@ Line 57: / Line 74: @@
 === Commands that enable / disable / toggle options: ===
+==Playlist Options==
   * ''PLAYLIST 1 OPTION <Name> ON'' - Enable a configuration option.
@@ Line 62: / Line 81: @@
   * ''PLAYLIST 1 OPTION <Name> ON/OFF'' - Toggle a configuration option.
-… where ''<Name>'' can be:
+  * … where ''<Name>'' can be:
+    * ''AutoFloat'' - Enable or disable auto float.
+    * ''AutomatorKeepNonPlayables'' - In automation mode keep or do not keep non-playable items.
+    * ''AutomationSinglePlayer'' - Use or do not use one single player for automation.
+    * ''AutoUnpackEmbeddedPlaylists'' - Do or do not unpack embedded playlists on loading.
+    * ''CleanUpHistory'' - Enable or disable moving skipped/played items into recycle bin.
+    * ''CleanUpHistoryTop'' - Enable or disable moving skipped/played items only from top into recycle bin.
+    * ''CleanUpNonPlayables'' - In automation mode enable or disable marking non-playable items as played.
+    * ''FixedTimeWaitHard'' - Wait or do not wait for hard fixtimes.
+    * ''FixedTimeWaitSoft'' - Wait or do not wait for soft fixtimes.
+    * ''HandleFixedTime'' - Move or do not move to fixtimes on automation mode.
+    * ''LiveBacktiming'' - Enable or disable updating backtiming information while neither player active.
+    * ''LogNonPlayables'' - Enable or disable logging of non-playable items.
+    * ''RepeatMode'' - Enable or disable repeat mode.
+    * ''UnpackEmbeddedPlaylistsDummy'' - Keep or do not keep embedded playlists as dummy after unpacking.
+    * ''UseRecycleBin'' - Move or do not move skipped items into recycle bin.
-{{:wiki:zeichen_123_-_arbeitsstelle_stvo_2013.svg.png?35|}} //Work in progress!//
+==Playlist GUI Options==
   * ''PLAYLIST 1 GUIOPTION <Name> ON'' - Enable a GUI option.
@@ Line 73: / Line 107: @@
     * ''AlbumArt'' - Show or hide album art.
     * ''AlwaysExpandContainers'' - Do or do not expand containers always.
-    * ''AlwaysShowDuration'' - Always show or hide duration.
+    * ''AlwaysShowDuration'' - Enable or disable always showing duration.
-    * ''AlwaysShowRamp'' - Always show or hide ramp.
+    * ''AlwaysShowRamp'' - Enable or disable always showing ramp.
-    * ''AutoRecycle'' - Do or do not recycle items automatically.
+    * ''AutoRecycle'' - Do or do not recycle items automatically on moving/inserting.
-    * ''Backtiming'' - Enable or disable backtiming.
+    * ''Backtiming'' - Enable or disable showing backtiming.
-    * ''BreakDuration'' - Show or hide break duration in automation.
+    * ''BreakDuration'' - Enable or disable showing break duration in automation automatically.
     * ''ColorRibbon'' - Show or hide color ribbon.
     * ''ColumnHeaders'' - Show or hide column headers.
     * ''CommentButtons'' - Show or hide comment buttons
-    * ''EOFWarningOverlay'' - Show or hide EOF warning overlay.
+    * ''EOFWarningOverlay'' - Show or hide EOF countdown as overlay.
-    * ''EscapeAutomationBreak'' - Enable or disable ''Esc'' key for automation break.
+    * ''EscapeAutomationBreak'' - Enable or disable ''Esc'' key for triggering ''AUTOMATION BREAK''.
-    * ''EscapeAutomationStop'' - Enable or disable ''Esc'' key for automation stop.
+    * ''EscapeAutomationStop'' - Enable or disable ''Esc'' key for triggering ''AUTOMATION STOP''.
     * ''ExpandComments'' - Expand or collapse comments.
-    * ''ExpandCotnainers'' - Expand or collapse containers.
+    * ''ExpandContainers'' - Expand or collapse containers.
-    * ''Extended'' -
+    * ''Extended'' - Enable or disable extended item view.
     * ''FixedItemColors'' - Enable or disable fixed item colours.
     * ''IconClickPFL'' - Enable or disable ExtraPFL by clicking on icon.
     * ''Icons'' - Show or hide playlist icons.
-    *
+    * ''ItemColorRibbons'' - Show or hide element colours as colour ribbon.
+    * ''ItemColorsRow'' - Show or hide element colours as background colours.
+    * ''NearestRamp'' - Show or hide nearest ramp only.
+    * ''PlayerColors'' - Use or do not use player colours.
+    * ''PlayerName'' - Show or hide player name in any condition.
+    * ''RampOverlay'' - Show or hide ramp countdown as overlay.
+    * ''SaveConfirmation'' - Enable or disable confirmaton on opening or closing.
+    * ''ScrollIntoView'' - Enable or disable scrolling to item playing.
+    * ''ShowPosition'' - Show or hide position.
+    * ''SpacebarAutomationNext'' - Enable or disable ''Spacebar'' for triggering ''AUTOMATION NEXT''.
+    * ''SwapArtistTitle'' - Enable or disable swapping Artist and Title in expanded view.
+    * ''TruncateTime'' - Enable or disable truncating time display automatically.
+    * ''Underruns'' - Show or hide underruns as additional rows.
+==Progress Bar Options==
   * ''PLAYLIST 1 PROGRESSBAR <Name> ON'' - Enable a progress bar option.
@@ Line 97: / Line 144: @@
   * ''PLAYLIST 1 PROGRESSBAR <Name> ON/OFF'' - Toggle a progress bar option.
-… where ''<Name>'' can be:
+  * … where ''<Name>'' can be:
+    * ''Enabled'' - Enable or disable progress bar.
-{{:wiki:zeichen_123_-_arbeitsstelle_stvo_2013.svg.png?35|}} //Work in progress!//
+    * ''NearestRamp'' - Show or do not show only the nearest ramp.
+    * ''Ramp'' - Show or do not show ramp.
+    * ''Split'' - Do or do not split progress bar during ramp.
 === Commands that control the automation: ===
@@ Line 218: / Line 267: @@
 === General commands: ===
-  * ''CARTWALL ALL CLICK'' -
+  * ''CARTWALL ALL CLICK'' - Emulate mouseclick on all cart players.
   * ''CARTWALL ALL CLOSE'' -
   * ''CARTWALL ALL DESELECT'' - Deselect all cart players.
@@ Line 232: / Line 281: @@
   * ''CARTWALL ALL START/PAUSE/STOP'' -
   * ''CARTWALL ALL START/STOP'' - Toggle between ''… START'' and ''… STOP''.
-  * ''CARTWALL ALL STOP'' - Stop playback on, reset and deselect all cart players.
+  * ''CARTWALL ALL STOP'' - Stop playback on, reset all cart players //on this cartwall page//.\\ For stopping playback on all cartwall pages, see ''CARTWALL STOP ALL''.
   * ''CARTWALL FADEOUT ALL'' - Fade all cart players out.
   * ''CARTWALL HIDE'' - Close cartwall window.
@@ Line 238: / Line 287: @@
   * ''CARTWALL LOAD PAGE <filename>'' -
   * ''CARTWALL LOAD PRESET <filename>'' -
-  * ''CARTWALL MODE OFF AIR'' -
+  * ''CARTWALL MODE OFF AIR'' - Put Cartwall into Off Air mode.
-  * ''CARTWALL MODE OFF AIR IF ON AIR'' -
+  * ''CARTWALL MODE OFF AIR IF ON AIR'' - Put Cartwall into Off Air mode if previous mode was On Air.
-  * ''CARTWALL MODE OFF AIR IF PFL'' -
+  * ''CARTWALL MODE OFF AIR IF PFL'' - Put Cartwall into Off Air mode if previous mode was PFL.
-  * ''CARTWALL MODE ON AIR'' -
+  * ''CARTWALL MODE ON AIR'' - Put Cartwall into On Air mode.
-  * ''CARTWALL MODE ON AIR IF OFF AIR'' -
+  * ''CARTWALL MODE ON AIR IF OFF AIR'' - Put Cartwall into On Air mode if previous mode was Off Air.
-  * ''CARTWALL MODE ON AIR IF PFL'' -
+  * ''CARTWALL MODE ON AIR IF PFL'' - Put Cartwall into On Air mode if previous mode was PFL.
-  * ''CARTWALL MODE PFL IF OFF AIR'' -
+  * ''CARTWALL MODE PFL IF OFF AIR'' - Put Cartwall into PFL mode if previous mode was Off Air.
   * ''CARTWALL NEXT'' -
   * ''CARTWALL NEXT PAGE'' - Show next cartwall page.
   * ''CARTWALL PREVIOUS PAGE'' - Show previous cartwall page.
-  * ''CARTWALL SELECTED CLICK'' -
+  * ''CARTWALL SELECTED CLICK'' - Emulate mouseclick on selected cart player (useful for loop applications).
   * ''CARTWALL SELECTED CLOSE'' -
   * ''CARTWALL SELECTED DESELECT'' - Deselect selected cart player(s).
@@ Line 267: / Line 316: @@
   * ''CARTWALL SHOW'' - Open cartwall window.
   * ''CARTWALL SHOW/HIDE'' - Toggle between ''… SHOW'' and ''… HIDE''.
-  * ''CARTWALL STOP ALL'' - Stop playback on, reset and deselect all cart players.
+  * ''CARTWALL STOP ALL'' - Stop playback on, reset all cart players //on all cartwall pages//.
 === Cartwall commands: ===
@@ Line 273: / Line 322: @@
 The following commands for the cartwall have the form ''CARTWALL x <command>'', where ''x'' is the number of the cart player, starting with ''1''.
-  * ''CARTWALL 1 CLICK'' -
+  * ''CARTWALL 1 CLICK'' - Emulate mouseclick on cart player 1 (useful for loop applications).
   * ''CARTWALL 1 CLOSE'' -
   * ''CARTWALL 1 DESELECT'' - Deselect cart player 1.
@@ Line 439: / Line 488: @@
 … where ''<filename>'' is the ''.txt'' file saved from the GUI.
-==== On Air ====
-  * ''OFF AIR'' - Leave On Air Mode.
-  * ''ON/OFF AIR'' - Toggle ''ON AIR'' and ''OFF AIR''.
-  * ''ON AIR'' - Incorporate On Air Mode.
 ==== Voice track ====
@@ Line 468: / Line 511: @@
   * ''NOVT'' can be used to mark commands only enabled if voicetracking is **not** active, e. g.: ''NOVT PLAYER 1-1 START; VT PLAYER A START'' makes some start button or -hotkey usable for both voicetracking and normal playout.
+  * ''ISVT'' can be used similarly to mark commands only enabled if voicetracking **is** active.
 ==== Aircheck Recorder ====
@@ Line 474: / Line 519: @@
   * ''<Remote ID> OPEN'' - Arm the Aircheck Recorder to record into the file specified in the screen object's settings. [[reference:logging_variables|Timestamp variables]] like ''%Y'', ''%M'', ''%D'', etc. may be used (recommended).
-  * ''<Remote ID> OPEN <filename>'' Same as above with ''<filename>'' overriding the preset path and filename.
+  * ''<Remote ID> OPEN <filename>'' - Same as above, with ''<filename>'' overriding the preset path and filename.
   * ''<Remote ID> ON'' - Start recording.
   * ''<Remote ID> OFF'' - Pause recording into the same file.
   * ''<Remote ID> CLOSE'' - Stop recording into the file and close (i. e. save) it.
+==== Comment Viewer ====
+The Comment Viewer can be employed as a window for displaying user-defined text messages. For this purpose it should obtain a unique ''<Remote ID>'', to be set in the //Advanced//-Tab of the respective screen object. There is no default value.
+  * ''<Remote ID> TEXT <Text>'' - Display ''<Text>'' in the Comment Viewer window.
+  * **Note** that some special characters can be accessed only by scripting:
+    * //New lines// should be substituted by ''#13+#10''.
+    * //Apostrophes//  should be substitited by ''#39''.
+    * //Semicolons// cannot be displayed. \\
+  * **Example:**((Remote ID selected as ''COMMENTVIEWER''))<code=delphi>
+  ExecuteCommand('COMMENTVIEWER TEXT Hello world' + #13+#10 + 'This is a ' + #39 + 'New Line' + #39);
+</code>yields<code>
+Hello world
+This is a 'New Line'</code>
 ==== Talk Timer ====
@@ Line 485: / Line 550: @@
   * ''TALKTIMER START/STOP'' - Toggle between ''… START'' and ''… STOP''.
   * ''TALKTIMER STOP'' - Stop the talk timer.
-==== System ====
-  * ''SLEEP <Value>'' - Can be used in connected commands ("chains") to have a pause of ''<Value>'' (in milliseconds) between two or more commands.
-  * ''RUNSCRIPT '<Path>' '' - Runs a script located at ''<Path>'' (with ''<Path>'' = ''C:\Path\to\Script.mls'' or the like).