]> git.sesse.net Git - casparcg/commitdiff
(no commit message)
authortk-3 <tk-3@362d55ac-95cf-4e76-9f9a-cbaa9c17b72d>
Tue, 13 Mar 2012 20:28:54 +0000 (20:28 +0000)
committertk-3 <tk-3@362d55ac-95cf-4e76-9f9a-cbaa9c17b72d>
Tue, 13 Mar 2012 20:28:54 +0000 (20:28 +0000)
source/amcp/basic-commands.rst

index cfd62311cabf86a2bef7b19fd0d46ca8aaafe4e8..c1b7871baed91b20c91f7f48eabae3fd9f8f3a05 100644 (file)
@@ -6,7 +6,7 @@ Basic Commands
 LOADBG\r
 ======\r
 Loads a producer in the background and prepares it for playout.\r
-If no layer is specified the default layer index will be used.\r
+If no layer is specified the default layer index(0) will be used.\r
 \r
 Syntax:: \r
 \r
@@ -15,36 +15,41 @@ Syntax::
 Example::\r
 \r
        >> LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
-               \r
+       \r
+Notes::\r
+\r
+       AUTO: This token will tell the layer to automatically play the background producer (with any specified transition) when the foreground producer ends.  Please note that some producers technically never end (still images) and this token will have no effect.  There will also be no effect when there is no producer playing in the foreground.\r
+       \r
 ====\r
 LOAD\r
 ====\r
 Loads a producer to the foreground and displays the first frame.\r
-If no layer is specified the default layer index will be used.\r
+If a producer was already playing in the foreground it will be removed.\r
+If no layer is specified the default layer index(0) will be used.\r
 \r
 Syntax:: \r
 \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
+       LOAD [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {parameters:string}}\r
        \r
 Example::      \r
 \r
-       >> LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
-       \r
+       >> LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 FILTER hflip\r
+               \r
 ====\r
 PLAY\r
 ====   \r
 Moves producer from background to foreground and starts playing it. If a transition (see LOADBG) is prepared, it will be executed.\r
-If additional parameters (see LOADBG) are provided then the provided producer will first be loaded to the background.\r
-If no layer is specified the default layer index will be used.\r
+If additional parameters (after the layer index) are provided then the specified producer will first be loaded to the background. This will clear out any LOADBG command that was previously executed, then the clip will be immediatelly transfered to the foreground.\r
+If no layer is specified the default layer index(0) will be used.\r
 \r
 Syntax::\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
+       PLAY [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {parameters:string}}\r
        \r
 Example::\r
 \r
-       >> PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
        >> PLAY 1-1\r
+       >> PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 FILTER hflip \r
        \r
 =====\r
 PAUSE\r
@@ -62,7 +67,7 @@ Example::
 =====\r
 STOP\r
 =====\r
-Removes foreground clip. If no layer is specified the default layer index will be used.\r
+Removes foreground clip. If no layer is specified the default layer index(0) will be used.\r
 \r
 Syntax::       \r
 \r
@@ -98,6 +103,7 @@ Syntax::
 Example::\r
 \r
        >> CALL 1-1 SEEK 400\r
+       >> CALL 1-1 LOOP 1\r
                \r
 ====\r
 SWAP\r
@@ -111,12 +117,13 @@ Syntax::
 Example::\r
 \r
        >> SWAP 1-1 1-2\r
-       >> SWAP 1-0 2-0         \r
+       >> SWAP 1-0 2-0\r
+       >> SWAP 1 2     \r
                \r
 ===\r
 ADD\r
 ===\r
-Adds consumer to output.\r
+Adds consumer to the channel.\r
 \r
 Syntax::\r
 \r
@@ -124,13 +131,14 @@ Syntax::
        \r
 Example::\r
 \r
-       >> ADD 1 FILE output.mov CODEC DNXHD\r
+       >> ADD 1 FILE output.mov -vcodec DNXHD\r
+       >> ADD 1 SCREEN\r
        >> ADD 1 DECKLINK 1\r
                \r
 ======\r
 REMOVE\r
 ======\r
-Removes consumer from output.\r
+Removes consumer from the channel.\r
 \r
 Syntax::\r
 \r