git.sesse.net Git - casparcg/blob - build/html/amcp/basic-commands.html

   1
   2
   3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6
   7 <html xmlns="http://www.w3.org/1999/xhtml">
   8   <head>
   9     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10
  11     <title>5. Basic Commands &mdash; CasparCG 2.0 documentation</title>
  12
  13     <link rel="stylesheet" href="../_static/default.css" type="text/css" />
  14     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  15
  16     <script type="text/javascript">
  17       var DOCUMENTATION_OPTIONS = {
  18         URL_ROOT:    '../',
  19         VERSION:     '2.0',
  20         COLLAPSE_INDEX: false,
  21         FILE_SUFFIX: '.html',
  22         HAS_SOURCE:  true
  23       };
  24     </script>
  25     <script type="text/javascript" src="../_static/jquery.js"></script>
  26     <script type="text/javascript" src="../_static/underscore.js"></script>
  27     <script type="text/javascript" src="../_static/doctools.js"></script>
  28     <script type="text/javascript" src="../_static/sidebar.js"></script>
  29     <link rel="search" type="application/opensearchdescription+xml"
  30           title="Search within CasparCG 2.0 documentation"
  31           href="../_static/opensearch.xml"/>
  32     <link rel="author" title="About these documents" href="../about.html" />
  33     <link rel="copyright" title="Copyright" href="../copyright.html" />
  34     <link rel="top" title="CasparCG 2.0 documentation" href="../index.html" />
  35     <link rel="up" title="AMCP 2.0 Reference" href="index.html" />
  36     <link rel="next" title="6. Template Graphics Commands" href="template-graphics-commands.html" />
  37     <link rel="prev" title="1. Communication" href="introduction.html" />
  38
  39
  40   </head>
  41   <body>
  42     <div class="related">
  43       <h3>Navigation</h3>
  44       <ul>
  45         <li class="right" style="margin-right: 10px">
  46           <a href="../genindex.html" title="General Index"
  47              accesskey="I">index</a></li>
  48         <li class="right" >
  49           <a href="template-graphics-commands.html" title="6. Template Graphics Commands"
  50              accesskey="N">next</a> |</li>
  51         <li class="right" >
  52           <a href="introduction.html" title="1. Communication"
  53              accesskey="P">previous</a> |</li>
  54         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
  55
  56           <li><a href="index.html" accesskey="U">AMCP 2.0 Reference</a> &raquo;</li>
  57       </ul>
  58     </div>
  59
  60     <div class="document">
  61       <div class="documentwrapper">
  62         <div class="bodywrapper">
  63           <div class="body">
  64
  65   <div class="section" id="basic-commands">
  66 <h1>5. Basic Commands<a class="headerlink" href="#basic-commands" title="Permalink to this headline">¶</a></h1>
  67 <div class="section" id="loadbg">
  68 <h2>5.1. LOADBG<a class="headerlink" href="#loadbg" title="Permalink to this headline">¶</a></h2>
  69 <p>Loads a producer in the background and prepares it for playout.
  70 If no layer is specified the default layer index will be used.</p>
  71 <p>Syntax:</p>
  72 <div class="highlight-python"><pre>LOADBG [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {auto:AUTO} {parameters:string}}</pre>
  73 </div>
  74 <p>Example:</p>
  75 <div class="highlight-python"><pre>&gt;&gt; LOADBG 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip</pre>
  76 </div>
  77 </div>
  78 <div class="section" id="load">
  79 <h2>5.2. LOAD<a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h2>
  80 <p>Loads a producer to the foreground and displays the first frame.
  81 If no layer is specified the default layer index will be used.</p>
  82 <p>Syntax:</p>
  83 <div class="highlight-python"><pre>LOAD [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {auto:AUTO} {parameters:string}}</pre>
  84 </div>
  85 <p>Example:</p>
  86 <div class="highlight-python"><pre>&gt;&gt; LOAD 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip</pre>
  87 </div>
  88 </div>
  89 <div class="section" id="play">
  90 <h2>5.3. PLAY<a class="headerlink" href="#play" title="Permalink to this headline">¶</a></h2>
  91 <p>Moves producer from background to foreground and starts playing it. If a transition (see LOADBG) is prepared, it will be executed.
  92 If additional parameters (see LOADBG) are provided then the provided producer will first be loaded to the background.
  93 If no layer is specified the default layer index will be used.</p>
  94 <p>Syntax:</p>
  95 <div class="highlight-python"><pre>PLAY [channel:int]-[layer:int] [clip:string] {[transition:CUT|MIX|PUSH|WIPE|SLIDE] [duration:int] {tween:string} {direction:LEFT|RIGHT} {auto:AUTO} {parameters:string}}</pre>
  96 </div>
  97 <p>Example:</p>
  98 <div class="highlight-python"><pre>&gt;&gt; PLAY 1-1 MY_VIDEO PUSH 20 easeinesine LOOP SEEK 200 LENGTH 400 AUTO FILTER hflip
  99 &gt;&gt; PLAY 1-1</pre>
 100 </div>
 101 </div>
 102 <div class="section" id="pause">
 103 <h2>5.4. PAUSE<a class="headerlink" href="#pause" title="Permalink to this headline">¶</a></h2>
 104 <p>Pauses foreground clip.</p>
 105 <p>Syntax:</p>
 106 <div class="highlight-python"><pre>PAUSE [channel:int]-[layer:int]</pre>
 107 </div>
 108 <p>Example:</p>
 109 <div class="highlight-python"><pre>&gt;&gt; PAUSE 1-1</pre>
 110 </div>
 111 </div>
 112 <div class="section" id="stop">
 113 <h2>5.5. STOP<a class="headerlink" href="#stop" title="Permalink to this headline">¶</a></h2>
 114 <p>Removes foreground clip. If no layer is specified the default layer index will be used.</p>
 115 <p>Syntax:</p>
 116 <div class="highlight-python"><pre>STOP [channel:int]-[layer:int]</pre>
 117 </div>
 118 <p>Example:</p>
 119 <div class="highlight-python"><pre>&gt;&gt; STOP 1-1</pre>
 120 </div>
 121 </div>
 122 <div class="section" id="clear">
 123 <h2>5.6. CLEAR<a class="headerlink" href="#clear" title="Permalink to this headline">¶</a></h2>
 124 <p>Removes both foreground and background clips. If no layer is specified then all layers in the specified video-channel are cleared.</p>
 125 <p>Syntax:</p>
 126 <div class="highlight-python"><pre>CLEAR [channel:int]{-[layer:int]}</pre>
 127 </div>
 128 <p>Example:</p>
 129 <div class="highlight-python"><pre>&gt;&gt; CLEAR 1-1
 130 &gt;&gt; CLEAR 1</pre>
 131 </div>
 132 </div>
 133 <div class="section" id="call">
 134 <h2>5.7. CALL<a class="headerlink" href="#call" title="Permalink to this headline">¶</a></h2>
 135 <p>Calls a producers specific function.</p>
 136 <p>Syntax:</p>
 137 <div class="highlight-python"><pre>CALL [channel:int]-[layer:int] [function:string] {parameters:string}</pre>
 138 </div>
 139 <p>Example:</p>
 140 <div class="highlight-python"><pre>&gt;&gt; CALL 1-1 SEEK 400</pre>
 141 </div>
 142 </div>
 143 <div class="section" id="swap">
 144 <h2>5.8. SWAP<a class="headerlink" href="#swap" title="Permalink to this headline">¶</a></h2>
 145 <p>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.</p>
 146 <p>Syntax:</p>
 147 <div class="highlight-python"><pre>SWAP [channel:int]{-[layer:int]} [channel:int]{-[layer:int]}</pre>
 148 </div>
 149 <p>Example:</p>
 150 <div class="highlight-python"><pre>&gt;&gt; SWAP 1-1 1-2
 151 &gt;&gt; SWAP 1-0 2-0</pre>
 152 </div>
 153 </div>
 154 <div class="section" id="add">
 155 <h2>5.9. ADD<a class="headerlink" href="#add" title="Permalink to this headline">¶</a></h2>
 156 <p>Adds consumer to output.</p>
 157 <p>Syntax:</p>
 158 <div class="highlight-python"><pre>ADD [channel:int] [consumer:string] {parameters:string}</pre>
 159 </div>
 160 <p>Example:</p>
 161 <div class="highlight-python"><pre>&gt;&gt; ADD 1 FILE output.mov CODEC DNXHD
 162 &gt;&gt; ADD 1 DECKLINK 1</pre>
 163 </div>
 164 </div>
 165 <div class="section" id="remove">
 166 <h2>5.10. REMOVE<a class="headerlink" href="#remove" title="Permalink to this headline">¶</a></h2>
 167 <p>Removes consumer from output.</p>
 168 <p>Syntax:</p>
 169 <div class="highlight-python"><pre>REMOVE [channel:int] [consumer:string] {parameters:string}</pre>
 170 </div>
 171 <p>Example:</p>
 172 <div class="highlight-python"><pre>&gt;&gt; REMOVE 1 FILE
 173 &gt;&gt; REMOVE 1 DECKLINK 1</pre>
 174 </div>
 175 </div>
 176 </div>
 177
 178
 179           </div>
 180         </div>
 181       </div>
 182       <div class="sphinxsidebar">
 183         <div class="sphinxsidebarwrapper">
 184   <h3><a href="../contents.html">Table Of Contents</a></h3>
 185   <ul>
 186 <li><a class="reference internal" href="#">5. Basic Commands</a><ul>
 187 <li><a class="reference internal" href="#loadbg">5.1. LOADBG</a></li>
 188 <li><a class="reference internal" href="#load">5.2. LOAD</a></li>
 189 <li><a class="reference internal" href="#play">5.3. PLAY</a></li>
 190 <li><a class="reference internal" href="#pause">5.4. PAUSE</a></li>
 191 <li><a class="reference internal" href="#stop">5.5. STOP</a></li>
 192 <li><a class="reference internal" href="#clear">5.6. CLEAR</a></li>
 193 <li><a class="reference internal" href="#call">5.7. CALL</a></li>
 194 <li><a class="reference internal" href="#swap">5.8. SWAP</a></li>
 195 <li><a class="reference internal" href="#add">5.9. ADD</a></li>
 196 <li><a class="reference internal" href="#remove">5.10. REMOVE</a></li>
 197 </ul>
 198 </li>
 199 </ul>
 200
 201   <h4>Previous topic</h4>
 202   <p class="topless"><a href="introduction.html"
 203                         title="previous chapter">1. Communication</a></p>
 204   <h4>Next topic</h4>
 205   <p class="topless"><a href="template-graphics-commands.html"
 206                         title="next chapter">6. Template Graphics Commands</a></p>
 207 <h3>This Page</h3>
 208 <ul class="this-page-menu">
 209   <li><a href="../bugs.html">Report a Bug</a></li>
 210   <li><a href="../_sources/amcp/basic-commands.txt"
 211          rel="nofollow">Show Source</a></li>
 212 </ul>
 213
 214 <div id="searchbox" style="display: none">
 215   <h3>Quick search</h3>
 216     <form class="search" action="../search.html" method="get">
 217       <input type="text" name="q" />
 218       <input type="submit" value="Go" />
 219       <input type="hidden" name="check_keywords" value="yes" />
 220       <input type="hidden" name="area" value="default" />
 221     </form>
 222     <p class="searchtip" style="font-size: 90%">
 223     Enter search terms or a module, class or function name.
 224     </p>
 225 </div>
 226 <script type="text/javascript">$('#searchbox').show(0);</script>
 227         </div>
 228       </div>
 229       <div class="clearer"></div>
 230     </div>
 231     <div class="related">
 232       <h3>Navigation</h3>
 233       <ul>
 234         <li class="right" style="margin-right: 10px">
 235           <a href="../genindex.html" title="General Index"
 236              >index</a></li>
 237         <li class="right" >
 238           <a href="template-graphics-commands.html" title="6. Template Graphics Commands"
 239              >next</a> |</li>
 240         <li class="right" >
 241           <a href="introduction.html" title="1. Communication"
 242              >previous</a> |</li>
 243         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 244
 245           <li><a href="index.html" >AMCP 2.0 Reference</a> &raquo;</li>
 246       </ul>
 247     </div>
 248     <div class="footer">
 249     &copy; <a href="../copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 250     <br />
 251     <a href="http://www.python.org/psf/donations/">Please donate.</a>
 252     <br />
 253     Last updated on Mar 13, 2012.
 254     <a href="../bugs.html">Found a bug</a>?
 255     <br />
 256     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 257     </div>
 258
 259   </body>
 260 </html>