(no commit message)

diff --git a/source/basic-commands.rst b/source/basic-commands.rst
index 10612ba97b71337455661de6fffa62219d630698..11e06b9e2684b9692f76a8ac75d942e4bbaf88c4 100644 (file)
--- a/source/basic-commands.rst
+++ b/source/basic-commands.rst
@@ -10,17 +10,7 @@ If no layer is specified the default layer index will be used.
 \r
 Syntax:: \r
 \r
-       LOADBG \r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               (?<producer>[\d\w]+) \r
-               (\r
-                       (?<transitions>CUT|MIX|PUSH|WIPE|SLIDE) \r
-                       (?<duration>\d+)\r
-                       (?<tween>(linear|easein|and-more))?{LINEAR}\r
-                       (?<direction>LEFT|RIGHT)?{RIGHT}\r
-               )?\r
-               (?<auto>AUTO)?\r
-               (?<parameters>.*)?\r
+       LOADBG [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {auto:AUTO} {parameters:string}}\r
                        \r
 Example::\r
 \r
@@ -34,17 +24,7 @@ If no layer is specified the default layer index will be used.
 \r
 Syntax:: \r
 \r
-       LOAD\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               (?<producer>[\d\w]+) \r
-               (\r
-                       (?<transitions>CUT|MIX|PUSH|WIPE|SLIDE) \r
-                       (?<duration>\d+)\r
-                       (?<tween>(linear|easein|and-more))?{LINEAR}\r
-                       (?<direction>LEFT|RIGHT)?{RIGHT}\r
-               )?\r
-               (?<auto>AUTO)?\r
-               (?<parameters>.*)?\r
+       LOAD [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {auto:AUTO} {parameters:string}}\r
        \r
 Example::      \r
 \r
@@ -58,18 +38,8 @@ If additional parameters (see LOADBG) are provided then the provided producer wi
 If no layer is specified the default layer index will be used.\r
 \r
 Syntax::\r
-\r
-       PLAY\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               (?<producer>[\d\w]+) \r
-               (\r
-                       (?<transitions>CUT|MIX|PUSH|WIPE|SLIDE) \r
-                       (?<duration>\d+)\r
-                       (?<tween>(linear|easein|and-more))?{LINEAR}\r
-                       (?<direction>LEFT|RIGHT)?{RIGHT}\r
-               )?\r
-               (?<auto>AUTO)?\r
-               (?<parameters>.*)?\r
+       \r
+       PLAY [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {auto:AUTO} {parameters:string}}\r
        \r
 Example::\r
 \r
@@ -83,8 +53,7 @@ Pauses foreground clip.
 \r
 Syntax::       \r
 \r
-       PAUSE \r
-               (?<video-channel>\d+)(-(?<layer>\d+))?  \r
+       PAUSE [channel:int]-[layer:int]\r
 \r
 Example::\r
 \r
@@ -97,8 +66,7 @@ Removes foreground clip. If no layer is specified the default layer index will b
 \r
 Syntax::       \r
 \r
-       STOP \r
-               (?<video-channel>\d+)(-(?<layer>\d+))?  \r
+       STOP [channel:int]-[layer:int]\r
 \r
 Example::\r
 \r
@@ -111,12 +79,12 @@ Removes both foreground and background clips. If no layer is specified then all
 \r
 Syntax::       \r
 \r
-       CLEAR \r
-               (?<video-channel>\d+)(-(?<layer>\d+))?  \r
+       CLEAR [channel:int]{-[layer:int]}\r
 \r
 Example::\r
 \r
        <<< CLEAR 1-1\r
+       <<< CLEAR 1\r
                \r
 ======\r
 CALL\r
@@ -125,10 +93,7 @@ Calls a producers specific function.
 \r
 Syntax::\r
 \r
-       CALL \r
-               (?<video-channel>\d+(-(?<layer>\d+))?\r
-               (?<function>[\d\w]+)\r
-               (?<parameters>.*)?\r
+       CALL [channel:int]-[layer:int] [function:string] {parameters:string}\r
 \r
 Example::\r
 \r
@@ -141,9 +106,7 @@ Swaps layers between channels (both foreground and background will be swapped).
 \r
 Syntax::\r
 \r
-       SWAP \r
-               (?<video-channel1>\d+)(-(?<layer1>\d+))?                \r
-               (?<video-channel2>\d+)(-(?<layer2>\d+))? \r
+       SWAP [channel:int]{-[layer:int]} [channel:int]{-[layer:int]}\r
 \r
 Example::\r
 \r
@@ -157,10 +120,7 @@ Adds consumer to output.
 \r
 Syntax::\r
 \r
-       ADD \r
-               (?<video-channel1>\d+) \r
-               (?<consumer>[\d\w]+) \r
-               (?<parameters>.*)\r
+       ADD [channel:int] [consumer:string] {parameters:string}\r
        \r
 Example::\r
 \r
@@ -174,10 +134,7 @@ Removes consumer from output.
 \r
 Syntax::\r
 \r
-       REMOVE \r
-               (?<video-channel1>\d+) \r
-               (?<consumer>[\d\w]+) \r
-               (?<parameters>.*)\r
+       REMOVE [channel:int] [consumer:string] {parameters:string}\r
 \r
 Example::\r
 \r

diff --git a/source/commands.rst b/source/commands.rst
index ccad63a8f4ee9c2de9891a9383f6377568488c56..e0bc3b30fde45f5b2d5d242a87600b4aeedc50de 100644 (file)
--- a/source/commands.rst
+++ b/source/commands.rst
@@ -38,12 +38,6 @@ Valid sequences:
 \r
 These sequences apply to all parameters, it doesn\'t matter if it\'s a file name or a long string of xml-data.\r
 \r
-*********************\r
-Command Specification\r
-*********************\r
-\r
-Commands are documented as regular expressions. Line-breaks represent whitespace (\s).\r
-\r
 ************\r
 Return codes\r
 ************\r

diff --git a/source/data-commands.rst b/source/data-commands.rst
index 0d40f0fa34b29602a00ee79c7f37c36dde471852..cfb4de056c997f5045f6ef41a94b813b3ec2eb99 100644 (file)
--- a/source/data-commands.rst
+++ b/source/data-commands.rst
@@ -11,9 +11,7 @@ Stores the dataset data under the name name.
 \r
 Syntax::\r
 \r
-       DATA STORE\r
-               (?<name>[\d\w]+)\r
-               (?<data>.+)\r
+       DATA STORE [name:string] [data:string]\r
                \r
 Example::\r
 \r
@@ -26,9 +24,7 @@ Returns the data saved under the name *name*.
 \r
 Syntax::\r
 \r
-       DATA STORE\r
-               (?<name>[\d\w]+)\r
-               (?<data>".*")\r
+       DATA RETRIEVE [name:string]\r
                \r
 Example::\r
 \r

diff --git a/source/misc-commands.rst b/source/misc-commands.rst
index 564ee7383fbca9b0590f3ea74343e2d537174117..756dcd4b1cd6591bbe878c1db77c086396193701 100644 (file)
--- a/source/misc-commands.rst
+++ b/source/misc-commands.rst
@@ -1,11 +1,10 @@
 *************\r
 Misc Commands\r
 *************\r
-Opens the diagnostics window.\r
-\r
 ====\r
 DIAG\r
 ====\r
+Opens the diagnostics window.\r
 \r
 Syntax::\r
 \r
@@ -13,7 +12,7 @@ Syntax::
        \r
 Example::\r
 \r
-       DIAG\r
+       <<< DIAG\r
        \r
 ===\r
 BYE\r
@@ -26,4 +25,17 @@ Syntax::
        \r
 Example\r
 \r
-       BYE
\ No newline at end of file
+       <<< BYE\r
+       \r
+====\r
+CHANNEL_GRID\r
+====\r
+Opens a window displaying all the channels currently running on the server.\r
+\r
+Syntax::\r
+\r
+       <<< CHANNEL_GRID\r
+       \r
+Example::\r
+\r
+       <<< CHANNEL_GRID
\ No newline at end of file

diff --git a/source/mixer-commands.rst b/source/mixer-commands.rst
index eb33d3d17659cdfa20d36e1e09d0365c3689cc65..6911b04cfc789304f33949c0c046797f563e14df 100644 (file)
--- a/source/mixer-commands.rst
+++ b/source/mixer-commands.rst
@@ -10,10 +10,7 @@ If *keyer* equals 1 then the specified layer will not be rendered, instead it wi
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               KEYER\r
-               (?<keyer>(0|1))\r
+       MIXER [channel:int]-[layer:int] KEYER [keyer:0|1]\r
                \r
 Example::\r
 \r
@@ -26,14 +23,16 @@ MIXER BLEND
 Syntax::\r
 \r
        MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               BLEND\r
-               (?<blend-mode>(0|1))\r
+               [channel:int]-[layer:int] BLEND [blend-mode:string]\r
                \r
 Example::\r
 \r
        <<< MIXER 1-1 BLEND overlay\r
        \r
+See:: \r
+\r
+Blend-modes.\r
+       \r
 =============\r
 MIXER OPACITY\r
 =============\r
@@ -41,13 +40,7 @@ MIXER OPACITY
 Syntax::\r
 \r
        MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               OPACITY\r
-               (?<opacity>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+               [channel:int]-[layer:int] OPACITY [opacity:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -59,14 +52,7 @@ MIXER BRIGTHNESS
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               BRIGTHNESS\r
-               (?<brightness>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+       MIXER [channel:int]-[layer:int] BRIGTHNESS [brightness:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -79,13 +65,7 @@ MIXER SATURATION
 Syntax::\r
 \r
        MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               SATURATION\r
-               (?<saturation>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+               [channel:int]-[layer:int] SATURATION [saturation:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -98,13 +78,7 @@ MIXER CONTRAST
 Syntax::\r
 \r
        MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               SATURATION\r
-               (?<contrast>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+               [channel:int]-[layer:int] CONTRAST [contrast:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -116,18 +90,7 @@ MIXER LEVELS
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               SATURATION\r
-               (?<min-input>(\d*\.?\d+))\r
-               (?<max-input>(\d*\.?\d+))\r
-               (?<gamma>(\d*\.?\d+))\r
-               (?<min-output>(\d*\.?\d+))\r
-               (?<max-output>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+       MIXER [channel:int]-[layer:int] SATURATION [min-input:double] [max-input:double] [gamma:double] [min-output:double] [max-output:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -140,17 +103,7 @@ Transforms the video stream on the specified layer.
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               FILL\r
-               (?<x>(\d*\.?\d+))\r
-               (?<y>(\d*\.?\d+))\r
-               (?<x-scale>(\d*\.?\d+))\r
-               (?<y-scale>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+       MIXER [channel:int]-[layer:int] FILL [x:double] [y:double] [x-scale:double] [y-scale:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -163,17 +116,7 @@ Masks the video stream on the specified layer.
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               CLIP\r
-               (?<x>(\d*\.?\d+))\r
-               (?<y>(\d*\.?\d+))\r
-               (?<x-scale>(\d*\.?\d+))\r
-               (?<y-scale>(\d*\.?\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+       MIXER [channel:int]-[layer:int] [x:double] [y:double] [x-scale:double] [y-scale:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -184,10 +127,7 @@ MIXER GRID
 ==========\r
 Creates a grid of video streams in ascending order of the layer index, i.e. if resolution equals 2 then a 2x2 grid of layers will be created.\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)\r
-               GRID\r
-               (?<resolution>(\d+))\r
+       MIXER [channel:int] RID [resolution:int]\r
                \r
 Example::\r
 \r
@@ -200,14 +140,7 @@ Changes the volume of the specified layer.
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               VOLUME\r
-               (?<volume>(\d+))\r
-               (\r
-                       (?<tween>\w+)\r
-                       (?<duration>\d+)\r
-               )?\r
+       MIXER [channel:int]-[layer:int] VOLUME [volume:double] {[tween:string] [duration:int]}\r
                \r
 Example::\r
 \r
@@ -219,9 +152,7 @@ MIXER CLEAR
 \r
 Syntax::\r
 \r
-       MIXER\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))? \r
-               CLEAR\r
+       MIXER [channel:int]-[layer:int] CLEAR\r
                \r
 Example::\r
 \r

diff --git a/source/producers.rst b/source/producers.rst
index 81e6386ffe9b13704b958919063a3682d3073819..d77ec169b0d275cca2e784a115793d93e6827c82 100644 (file)
--- a/source/producers.rst
+++ b/source/producers.rst
@@ -53,7 +53,7 @@ Sets whether file will loop.
 \r
 Syntax::\r
 \r
-       LOOP (?<frame>0|1)\r
+       LOOP [loop:0|1]\r
        \r
 ^^^^\r
 SEEK\r
@@ -62,7 +62,7 @@ Sets the start of the file. This point will be used while looping.
 \r
 Syntax::\r
 \r
-       SEEK (?<frames>\d+)\r
+       SEEK [frames:int]\r
        \r
 Example::\r
        \r
@@ -75,7 +75,7 @@ Sets the end of the file.
 \r
 Syntax::\r
 \r
-       LENGTH (?<frames>\d+)\r
+       LENGTH [frames:int]\r
        \r
 Example::\r
        \r
@@ -88,7 +88,7 @@ Configures as libavfilter which will be used for the file.
 \r
 Syntax::\r
 \r
-       FILTER (?<libavfilter-parameters>[\d\w]+)\r
+       FILTER [libavfilter-parameters:string]\r
                \r
 Example::\r
                \r
@@ -105,7 +105,7 @@ Sets whether file will loop.
 \r
 Syntax::\r
 \r
-       LOOP (?<frame>0|1)?\r
+       LOOP [loop:0|1]\r
        \r
 Returns\r
 \r
@@ -123,7 +123,7 @@ Seeks in the file.
 \r
 Syntax::\r
 \r
-       SEEK (?<frames>\d+)\r
+       SEEK [frames:int]\r
        \r
 Returns\r
 \r

diff --git a/source/query-commands.rst b/source/query-commands.rst
index 501e10779d33a1128dafcf9ab834dbfab3fac0de..9abc3146fe6f3fa0999eeed2e7bdddb0b365d177 100644 (file)
--- a/source/query-commands.rst
+++ b/source/query-commands.rst
@@ -9,8 +9,7 @@ Returns information about a mediafile.
 \r
 Syntax::\r
 \r
-       CINF\r
-               (?<filename>[\d\w]+)\r
+       CINF [filename:string]\r
                \r
 Example::\r
 \r
@@ -52,8 +51,7 @@ Returns the version of specified component.
 \r
 Syntax::\r
 \r
-       VERSION\r
-               (FLASH)?\r
+       VERSION {SERVER|FLASH}\r
                \r
 Example::\r
 \r
@@ -69,8 +67,7 @@ Returns information about the server. The TEMPLATE version will read and return
 \r
 Syntax::\r
 \r
-       VERSION\r
-               ((?<video-channel>\d+)(-(?<layer>\d+)))|(TEMPLATE (?<template>[\d\w]+)))?\r
+       INFO ([channel:int]{-[layer:int]}|TEMPLATE [filename:string])\r
                \r
 Example::\r
 \r

diff --git a/source/template-graphics-commands.rst b/source/template-graphics-commands.rst
index f96eebd02b1b96776e5ea3e8d8ae6e1758f408e2..094ce42e3aaa84889bd55c11ace12a17a3c536b6 100644 (file)
--- a/source/template-graphics-commands.rst
+++ b/source/template-graphics-commands.rst
@@ -33,13 +33,7 @@ Data is either inline xml or a reference to a saved dataset.
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               ADD\r
-               (?<template-layer>\d+)\r
-               (?<template>[\d\w]+)\r
-               (?<play-on-load>(0|1))?\r
-               (?<data>".*")\r
+       CG [channel:int]-[layer:int] ADD [template-host-layer:int] [template:string] {[play-on-load:0|1]} {[data:string]}\r
                \r
 Example::\r
 \r
@@ -52,10 +46,7 @@ Removes the visible template from a specific layer.
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               REMOVE\r
-               (?<template-layer>\d+)\r
+       CG [channel:int]-[layer:int] REMOVE [template-host-layer:int] \r
                \r
 Example::\r
 \r
@@ -68,9 +59,7 @@ Clears all layers and any state that might be stored. What this actually does be
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               CLEAR\r
+       CG channel:int]-[layer:int]     CLEAR\r
                \r
 Example::\r
 \r
@@ -83,10 +72,7 @@ Plays and displays the template in the specified layer.
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               PLAY\r
-               (?<template-layer>\d+)\r
+       CG [channel:int]-[layer:int] PLAY [template-host-layer:int] \r
                \r
 Example::\r
 \r
@@ -99,10 +85,7 @@ Stops and removes the template from the specified layer. This is different than
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               STOP\r
-               (?<template-layer>\d+)\r
+       CG [channel:int]-[layer:int] STOP [template-host-layer:int] \r
                \r
 Example::\r
 \r
@@ -115,10 +98,7 @@ Triggers a "continue" in the template on the specified layer. This is used to co
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               NEXT\r
-               (?<template-layer>\d+)\r
+       CG [channel:int]-[layer:int] NEXT [template-host-layer:int] \r
                \r
 Example::\r
 \r
@@ -131,11 +111,7 @@ Jumps to the specified label in the template on the specified layer.
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               GOTO\r
-               (?<template-layer>\d+)\r
-               (?<label>[\d\w]+)\r
+       CG [channel:int]-[layer:int] GOTO [template-host-layer:int] {[label:string]}\r
                \r
 Example::\r
 \r
@@ -148,11 +124,7 @@ Sends new data to the template on specified layer. Data is either inline xml or
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               UPDATE\r
-               (?<template-layer>\d+)\r
-               (?<data>".*")\r
+       CG [channel:int]-[layer:int] UPDATE [template-host-layer:int] [data:string]\r
                \r
 Example::\r
 \r
@@ -165,12 +137,8 @@ Calls a custom method in the document class of the template on the specified lay
 \r
 Syntax::\r
 \r
-       CG\r
-               (?<video-channel>[1-9]+)(-(?<layer>\d+))?\r
-               PLAY\r
-               (?<template-layer>\d+)\r
-               (?<method>[\d\w]+)\r
+       CG [channel:int]-[layer:int] INVOKE [template-host-layer:int] [method:string]\r
                \r
 Example::\r
 \r
-       <<< CG 1-1 GOTO 1 start_intro
\ No newline at end of file
+       <<< CG 1-1 INVOKE 1 start_intro
\ No newline at end of file