git.sesse.net Git - casparcg/blob - build/html/contents.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>CasparCG Documentation Contents &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="next" title="What’s New in CasparCG" href="whatsnew/index.html" />
  36
  37
  38   </head>
  39   <body>
  40     <div class="related">
  41       <h3>Navigation</h3>
  42       <ul>
  43         <li class="right" style="margin-right: 10px">
  44           <a href="genindex.html" title="General Index"
  45              accesskey="I">index</a></li>
  46         <li class="right" >
  47           <a href="whatsnew/index.html" title="What’s New in CasparCG"
  48              accesskey="N">next</a> |</li>
  49         <li><a href="index.html">CasparCG 2.0 documentation</a> &raquo;</li>
  50
  51       </ul>
  52     </div>
  53
  54     <div class="document">
  55       <div class="documentwrapper">
  56         <div class="bodywrapper">
  57           <div class="body">
  58
  59   <div class="section" id="casparcg-documentation-contents">
  60 <h1>CasparCG Documentation Contents<a class="headerlink" href="#casparcg-documentation-contents" title="Permalink to this headline">¶</a></h1>
  61 <div class="toctree-wrapper compound">
  62 <ul>
  63 <li class="toctree-l1"><a class="reference internal" href="whatsnew/index.html">What&#8217;s New in CasparCG</a><ul>
  64 <li class="toctree-l2"><a class="reference internal" href="whatsnew/2_0.html">What&#8217;s New in CasparCG 2.0</a><ul>
  65 <li class="toctree-l3"><a class="reference internal" href="whatsnew/2_0.html#introduction">Introduction</a></li>
  66 </ul>
  67 </li>
  68 </ul>
  69 </li>
  70 <li class="toctree-l1"><a class="reference internal" href="amcp/index.html">AMCP 2.0 Reference</a><ul>
  71 <li class="toctree-l2"><a class="reference internal" href="amcp/introduction.html">1. Communication</a></li>
  72 <li class="toctree-l2"><a class="reference internal" href="amcp/introduction.html#backwards-compatibility">2. Backwards Compatibility</a><ul>
  73 <li class="toctree-l3"><a class="reference internal" href="amcp/introduction.html#breaking-changes">2.1. Breaking Changes</a></li>
  74 </ul>
  75 </li>
  76 <li class="toctree-l2"><a class="reference internal" href="amcp/introduction.html#special-sequences">3. Special sequences</a></li>
  77 <li class="toctree-l2"><a class="reference internal" href="amcp/introduction.html#return-codes">4. Return codes</a><ul>
  78 <li class="toctree-l3"><a class="reference internal" href="amcp/introduction.html#information">4.1. Information</a></li>
  79 <li class="toctree-l3"><a class="reference internal" href="amcp/introduction.html#successful">4.2. Successful</a></li>
  80 <li class="toctree-l3"><a class="reference internal" href="amcp/introduction.html#client-error">4.3. Client Error</a></li>
  81 <li class="toctree-l3"><a class="reference internal" href="amcp/introduction.html#server-error">4.4. Server Error</a></li>
  82 </ul>
  83 </li>
  84 <li class="toctree-l2"><a class="reference internal" href="amcp/basic-commands.html">5. Basic Commands</a><ul>
  85 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#loadbg">5.1. LOADBG</a></li>
  86 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#load">5.2. LOAD</a></li>
  87 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#play">5.3. PLAY</a></li>
  88 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#pause">5.4. PAUSE</a></li>
  89 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#stop">5.5. STOP</a></li>
  90 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#clear">5.6. CLEAR</a></li>
  91 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#call">5.7. CALL</a></li>
  92 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#swap">5.8. SWAP</a></li>
  93 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#add">5.9. ADD</a></li>
  94 <li class="toctree-l3"><a class="reference internal" href="amcp/basic-commands.html#remove">5.10. REMOVE</a></li>
  95 </ul>
  96 </li>
  97 <li class="toctree-l2"><a class="reference internal" href="amcp/template-graphics-commands.html">6. Template Graphics Commands</a><ul>
  98 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-add">6.1. CG ADD</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-remove">6.2. CG REMOVE</a></li>
 100 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-clear">6.3. CG CLEAR</a></li>
 101 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-play">6.4. CG PLAY</a></li>
 102 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-stop">6.5. CG STOP</a></li>
 103 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-next">6.6. CG NEXT</a></li>
 104 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-goto">6.7. CG GOTO</a></li>
 105 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-update">6.8. CG UPDATE</a></li>
 106 <li class="toctree-l3"><a class="reference internal" href="amcp/template-graphics-commands.html#cg-invoke">6.9. CG INVOKE</a></li>
 107 </ul>
 108 </li>
 109 <li class="toctree-l2"><a class="reference internal" href="amcp/data-commands.html">7. Data Commands</a><ul>
 110 <li class="toctree-l3"><a class="reference internal" href="amcp/data-commands.html#data-store">7.1. DATA STORE</a></li>
 111 <li class="toctree-l3"><a class="reference internal" href="amcp/data-commands.html#data-retrieve">7.2. DATA RETRIEVE</a></li>
 112 <li class="toctree-l3"><a class="reference internal" href="amcp/data-commands.html#data-list">7.3. DATA LIST</a></li>
 113 </ul>
 114 </li>
 115 <li class="toctree-l2"><a class="reference internal" href="amcp/mixer-commands.html">8. Mixer Commands</a><ul>
 116 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-keyer">8.1. MIXER KEYER</a></li>
 117 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-blend">8.2. MIXER BLEND</a></li>
 118 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-opacity">8.3. MIXER OPACITY</a></li>
 119 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-brigthness">8.4. MIXER BRIGTHNESS</a></li>
 120 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-saturation">8.5. MIXER SATURATION</a></li>
 121 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-contrast">8.6. MIXER CONTRAST</a></li>
 122 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-levels">8.7. MIXER LEVELS</a></li>
 123 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-fill">8.8. MIXER FILL</a></li>
 124 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-clip">8.9. MIXER CLIP</a></li>
 125 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-grid">8.10. MIXER GRID</a></li>
 126 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-volume">8.11. MIXER VOLUME</a></li>
 127 <li class="toctree-l3"><a class="reference internal" href="amcp/mixer-commands.html#mixer-clear">8.12. MIXER CLEAR</a></li>
 128 </ul>
 129 </li>
 130 <li class="toctree-l2"><a class="reference internal" href="amcp/query-commands.html">9. Query Commands</a><ul>
 131 <li class="toctree-l3"><a class="reference internal" href="amcp/query-commands.html#cinf">9.1. CINF</a></li>
 132 <li class="toctree-l3"><a class="reference internal" href="amcp/query-commands.html#cls">9.2. CLS</a></li>
 133 <li class="toctree-l3"><a class="reference internal" href="amcp/query-commands.html#tls">9.3. TLS</a></li>
 134 <li class="toctree-l3"><a class="reference internal" href="amcp/query-commands.html#version">9.4. VERSION</a></li>
 135 <li class="toctree-l3"><a class="reference internal" href="amcp/query-commands.html#info">9.5. INFO</a></li>
 136 </ul>
 137 </li>
 138 <li class="toctree-l2"><a class="reference internal" href="amcp/misc-commands.html">10. Misc Commands</a><ul>
 139 <li class="toctree-l3"><a class="reference internal" href="amcp/misc-commands.html#diag">10.1. DIAG</a></li>
 140 <li class="toctree-l3"><a class="reference internal" href="amcp/misc-commands.html#bye">10.2. BYE</a></li>
 141 <li class="toctree-l3"><a class="reference internal" href="amcp/misc-commands.html#channel-grid">10.3. CHANNEL_GRID</a></li>
 142 </ul>
 143 </li>
 144 </ul>
 145 </li>
 146 <li class="toctree-l1"><a class="reference internal" href="producers/index.html">Producers</a><ul>
 147 <li class="toctree-l2"><a class="reference internal" href="producers/ffmpeg.html">1. FFMPEG Producer</a><ul>
 148 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#supported-media">1.1. Supported Media</a></li>
 149 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#filters">1.2. Filters</a></li>
 150 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#diagnostics">1.3. Diagnostics</a></li>
 151 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#parameters">1.4. Parameters</a><ul>
 152 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#loop">1.4.1. LOOP</a></li>
 153 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#seek">1.4.2. SEEK</a></li>
 154 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#start-casparcg-2-1">1.4.3. START (CasparCG 2.1)</a></li>
 155 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#length">1.4.4. LENGTH</a></li>
 156 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#filter">1.4.5. FILTER</a></li>
 157 </ul>
 158 </li>
 159 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#functions">1.5. Functions</a><ul>
 160 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#id1">1.5.1. LOOP</a></li>
 161 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#id2">1.5.2. SEEK</a></li>
 162 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#id3">1.5.3. START (CasparCG 2.1)</a></li>
 163 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#length-casparcg-2-1">1.5.4. LENGTH (CasparCG 2.1)</a></li>
 164 </ul>
 165 </li>
 166 </ul>
 167 </li>
 168 <li class="toctree-l2"><a class="reference internal" href="producers/flash.html">2. Flash Producer</a><ul>
 169 <li class="toctree-l3"><a class="reference internal" href="producers/flash.html#supported-media">2.1. Supported Media</a></li>
 170 <li class="toctree-l3"><a class="reference internal" href="producers/flash.html#diagnostics">2.2. Diagnostics</a></li>
 171 </ul>
 172 </li>
 173 <li class="toctree-l2"><a class="reference internal" href="producers/image.html">3. Image Producer</a></li>
 174 <li class="toctree-l2"><a class="reference internal" href="producers/image-scroll.html">4. Image Scroll Producer</a></li>
 175 <li class="toctree-l2"><a class="reference internal" href="producers/decklink.html">5. Decklink Producer</a><ul>
 176 <li class="toctree-l3"><a class="reference internal" href="producers/decklink.html#diagnostics">5.1. Diagnostics</a></li>
 177 <li class="toctree-l3"><a class="reference internal" href="producers/decklink.html#parameters">5.2. Parameters</a><ul>
 178 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#device">5.2.1. DEVICE</a></li>
 179 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#length">5.2.2. LENGTH</a></li>
 180 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#filter">5.2.3. FILTER</a></li>
 181 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#format">5.2.4. FORMAT</a></li>
 182 </ul>
 183 </li>
 184 </ul>
 185 </li>
 186 </ul>
 187 </li>
 188 <li class="toctree-l1"><a class="reference internal" href="consumers/index.html">Consumers</a><ul>
 189 <li class="toctree-l2"><a class="reference internal" href="consumers/decklink.html">1. Decklink Consumer</a><ul>
 190 <li class="toctree-l3"><a class="reference internal" href="consumers/decklink.html#diagnostics">1.1. Diagnostics</a></li>
 191 <li class="toctree-l3"><a class="reference internal" href="consumers/decklink.html#parameters">1.2. Parameters</a><ul>
 192 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#device">1.2.1. DEVICE</a></li>
 193 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#embedded-audio">1.2.2. EMBEDDED_AUDIO</a></li>
 194 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#key-only">1.2.3. KEY_ONLY</a></li>
 195 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#latency">1.2.4. LATENCY</a></li>
 196 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#keyer">1.2.5. KEYER</a></li>
 197 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#buffer-depth">1.2.6. BUFFER_DEPTH</a></li>
 198 </ul>
 199 </li>
 200 </ul>
 201 </li>
 202 <li class="toctree-l2"><a class="reference internal" href="consumers/bluefish.html">2. Bluefish Consumer</a><ul>
 203 <li class="toctree-l3"><a class="reference internal" href="consumers/bluefish.html#diagnostics">2.1. Diagnostics</a></li>
 204 <li class="toctree-l3"><a class="reference internal" href="consumers/bluefish.html#parameters">2.2. Parameters</a><ul>
 205 <li class="toctree-l4"><a class="reference internal" href="consumers/bluefish.html#device">2.2.1. DEVICE</a></li>
 206 <li class="toctree-l4"><a class="reference internal" href="consumers/bluefish.html#embedded-audio">2.2.2. EMBEDDED_AUDIO</a></li>
 207 <li class="toctree-l4"><a class="reference internal" href="consumers/bluefish.html#key-only">2.2.3. KEY_ONLY</a></li>
 208 </ul>
 209 </li>
 210 </ul>
 211 </li>
 212 <li class="toctree-l2"><a class="reference internal" href="consumers/screen.html">3. Screen Consumer</a></li>
 213 <li class="toctree-l2"><a class="reference internal" href="consumers/system-audio.html">4. System Audio Consumer</a></li>
 214 <li class="toctree-l2"><a class="reference internal" href="consumers/file.html">5. File Consumer</a><ul>
 215 <li class="toctree-l3"><a class="reference internal" href="consumers/file.html#diagnostics">5.1. Diagnostics</a></li>
 216 <li class="toctree-l3"><a class="reference internal" href="consumers/file.html#parameters">5.2. Parameters</a><ul>
 217 <li class="toctree-l4"><a class="reference internal" href="consumers/file.html#filename">5.2.1. FILENAME</a></li>
 218 </ul>
 219 </li>
 220 </ul>
 221 </li>
 222 <li class="toctree-l2"><a class="reference internal" href="consumers/image.html">6. Image Consumer</a></li>
 223 </ul>
 224 </li>
 225 <li class="toctree-l1"><a class="reference internal" href="faq/index.html">CasparCG Frequently Asked Questions</a><ul>
 226 <li class="toctree-l2"><a class="reference internal" href="faq/general.html">General CasparCG FAQ</a></li>
 227 <li class="toctree-l2"><a class="reference internal" href="faq/decklink.html">Decklink FAQ</a></li>
 228 <li class="toctree-l2"><a class="reference internal" href="faq/bluefish.html">Bluefish FAQ</a></li>
 229 </ul>
 230 </li>
 231 <li class="toctree-l1"><a class="reference internal" href="about.html">About these documents</a></li>
 232 <li class="toctree-l1"><a class="reference internal" href="bugs.html">Reporting Bugs</a></li>
 233 <li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
 234 <li class="toctree-l1"><a class="reference internal" href="license.html">History and License</a></li>
 235 </ul>
 236 </div>
 237 </div>
 238
 239
 240           </div>
 241         </div>
 242       </div>
 243       <div class="sphinxsidebar">
 244         <div class="sphinxsidebarwrapper">
 245   <h4>Next topic</h4>
 246   <p class="topless"><a href="whatsnew/index.html"
 247                         title="next chapter">What&#8217;s New in CasparCG</a></p>
 248 <h3>This Page</h3>
 249 <ul class="this-page-menu">
 250   <li><a href="bugs.html">Report a Bug</a></li>
 251   <li><a href="_sources/contents.txt"
 252          rel="nofollow">Show Source</a></li>
 253 </ul>
 254
 255 <div id="searchbox" style="display: none">
 256   <h3>Quick search</h3>
 257     <form class="search" action="search.html" method="get">
 258       <input type="text" name="q" />
 259       <input type="submit" value="Go" />
 260       <input type="hidden" name="check_keywords" value="yes" />
 261       <input type="hidden" name="area" value="default" />
 262     </form>
 263     <p class="searchtip" style="font-size: 90%">
 264     Enter search terms or a module, class or function name.
 265     </p>
 266 </div>
 267 <script type="text/javascript">$('#searchbox').show(0);</script>
 268         </div>
 269       </div>
 270       <div class="clearer"></div>
 271     </div>
 272     <div class="related">
 273       <h3>Navigation</h3>
 274       <ul>
 275         <li class="right" style="margin-right: 10px">
 276           <a href="genindex.html" title="General Index"
 277              >index</a></li>
 278         <li class="right" >
 279           <a href="whatsnew/index.html" title="What’s New in CasparCG"
 280              >next</a> |</li>
 281         <li><a href="index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 282
 283       </ul>
 284     </div>
 285     <div class="footer">
 286     &copy; <a href="copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 287     <br />
 288     <a href="http://www.python.org/psf/donations/">Please donate.</a>
 289     <br />
 290     Last updated on Mar 11, 2012.
 291     <a href="bugs.html">Found a bug</a>?
 292     <br />
 293     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 294     </div>
 295
 296   </body>
 297 </html>