git.sesse.net Git - casparcg/blob - source/basic-commands.rst

   1 **************\r
   2 Basic Commands\r
   3 **************\r
   4 \r
   5 ======\r
   6 LOADBG\r
   7 ======\r
   8 Loads a producer in the background and prepares it for playout.\r
   9 If no layer is specified the default layer index will be used.\r
  10 \r
  11 Syntax:: \r
  12 \r
  13         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
  14                         \r
  15 Example::\r
  16 \r
  17         <<< LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
  18                 \r
  19 ====\r
  20 LOAD\r
  21 ====\r
  22 Loads a producer to the foreground and displays the first frame.\r
  23 If no layer is specified the default layer index will be used.\r
  24 \r
  25 Syntax:: \r
  26 \r
  27         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
  28         \r
  29 Example::       \r
  30 \r
  31         <<< LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
  32         \r
  33 ====\r
  34 PLAY\r
  35 ====    \r
  36 Moves producer from background to foreground and starts playing it. If a transition (see LOADBG) is prepared, it will be executed.\r
  37 If additional parameters (see LOADBG) are provided then the provided producer will first be loaded to the background.\r
  38 If no layer is specified the default layer index will be used.\r
  39 \r
  40 Syntax::\r
  41         \r
  42         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
  43         \r
  44 Example::\r
  45 \r
  46         <<< PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip \r
  47         <<< PLAY 1-1\r
  48         \r
  49 =====\r
  50 PAUSE\r
  51 =====\r
  52 Pauses foreground clip.\r
  53 \r
  54 Syntax::        \r
  55 \r
  56         PAUSE [channel:int]-[layer:int]\r
  57 \r
  58 Example::\r
  59 \r
  60         <<< PAUSE 1-1\r
  61         \r
  62 =====\r
  63 STOP\r
  64 =====\r
  65 Removes foreground clip. If no layer is specified the default layer index will be used.\r
  66 \r
  67 Syntax::        \r
  68 \r
  69         STOP [channel:int]-[layer:int]\r
  70 \r
  71 Example::\r
  72 \r
  73         <<< STOP 1-1\r
  74 \r
  75 =====\r
  76 CLEAR\r
  77 =====\r
  78 Removes both foreground and background clips. If no layer is specified then all layers in the specified video-channel are cleared.\r
  79 \r
  80 Syntax::        \r
  81 \r
  82         CLEAR [channel:int]{-[layer:int]}\r
  83 \r
  84 Example::\r
  85 \r
  86         <<< CLEAR 1-1\r
  87         <<< CLEAR 1\r
  88                 \r
  89 ======\r
  90 CALL\r
  91 ======\r
  92 Calls a producers specific function.\r
  93 \r
  94 Syntax::\r
  95 \r
  96         CALL [channel:int]-[layer:int] [function:string] {parameters:string}\r
  97 \r
  98 Example::\r
  99 \r
 100         <<< CALL 1-1 SEEK 400\r
 101                 \r
 102 ====\r
 103 SWAP\r
 104 ====\r
 105 Swaps layers between channels (both foreground and background will be swapped). If layers are not specified then all layers in respective video-channel will be swapped.\r
 106 \r
 107 Syntax::\r
 108 \r
 109         SWAP [channel:int]{-[layer:int]} [channel:int]{-[layer:int]}\r
 110 \r
 111 Example::\r
 112 \r
 113         <<< SWAP 1-1 1-2\r
 114         <<< SWAP 1-0 2-0                \r
 115                 \r
 116 ===\r
 117 ADD\r
 118 ===\r
 119 Adds consumer to output.\r
 120 \r
 121 Syntax::\r
 122 \r
 123         ADD [channel:int] [consumer:string] {parameters:string}\r
 124         \r
 125 Example::\r
 126 \r
 127         <<< ADD 1 FILE output.mov CODEC DNXHD\r
 128         <<< ADD 1 DECKLINK 1\r
 129                 \r
 130 ======\r
 131 REMOVE\r
 132 ======\r
 133 Removes consumer from output.\r
 134 \r
 135 Syntax::\r
 136 \r
 137         REMOVE [channel:int] [consumer:string] {parameters:string}\r
 138 \r
 139 Example::\r
 140 \r
 141         <<< REMOVE 1 FILE \r
 142         <<< REMOVE 1 DECKLINK 1