git.sesse.net Git - casparcg/blob - build/html/consumers/consumers.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>1. Consumers &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="Consumers" href="index.html" />
  36     <link rel="next" title="CasparCG Frequently Asked Questions" href="../faq/index.html" />
  37     <link rel="prev" title="Consumers" href="index.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="../faq/index.html" title="CasparCG Frequently Asked Questions"
  50              accesskey="N">next</a> |</li>
  51         <li class="right" >
  52           <a href="index.html" title="Consumers"
  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">Consumers</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="consumers">
  66 <h1>1. Consumers<a class="headerlink" href="#consumers" title="Permalink to this headline">¶</a></h1>
  67 <div class="section" id="file-consumer">
  68 <h2>1.1. File Consumer<a class="headerlink" href="#file-consumer" title="Permalink to this headline">¶</a></h2>
  69 <div class="section" id="diagnostics">
  70 <h3>1.1.1. Diagnostics<a class="headerlink" href="#diagnostics" title="Permalink to this headline">¶</a></h3>
  71 <p>ffmpeg[<em>filename</em>]</p>
  72 <table border="1" class="docutils">
  73 <colgroup>
  74 <col width="21%" />
  75 <col width="67%" />
  76 <col width="11%" />
  77 </colgroup>
  78 <thead valign="bottom">
  79 <tr class="row-odd"><th class="head">Graph</th>
  80 <th class="head">Description</th>
  81 <th class="head">Scale</th>
  82 </tr>
  83 </thead>
  84 <tbody valign="top">
  85 <tr class="row-even"><td>frame-time</td>
  86 <td>Time spent decoding the current frame.</td>
  87 <td>fps/2</td>
  88 </tr>
  89 </tbody>
  90 </table>
  91 </div>
  92 <div class="section" id="parameters">
  93 <h3>1.1.2. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h3>
  94 <p>The file consumer uses the same option syntax as ffmpeg.</p>
  95 <p>Note, not all options supported by ffmpeg have been implemented.</p>
  96 <div class="section" id="filename">
  97 <h4>1.1.2.1. FILENAME<a class="headerlink" href="#filename" title="Permalink to this headline">¶</a></h4>
  98 <p>Target filename.</p>
  99 <p>Syntax:</p>
 100 <div class="highlight-python"><pre>[filename:string]</pre>
 101 </div>
 102 <p>Example:</p>
 103 <div class="highlight-python"><pre>ADD 1 FILE test.mov -vcodec libx264 -crf 5 -preset ultrafast -tune fastdecode -s 1280x720 -r 50 -acodec aac -ab 128k
 104 REMOVE 1 FILE</pre>
 105 </div>
 106 </div>
 107 </div>
 108 </div>
 109 <div class="section" id="bluefish-consumer">
 110 <h2>1.2. Bluefish Consumer<a class="headerlink" href="#bluefish-consumer" title="Permalink to this headline">¶</a></h2>
 111 <div class="section" id="id1">
 112 <h3>1.2.1. Diagnostics<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
 113 <p>ffmpeg[<em>filename</em>]</p>
 114 <table border="1" class="docutils">
 115 <colgroup>
 116 <col width="21%" />
 117 <col width="67%" />
 118 <col width="11%" />
 119 </colgroup>
 120 <thead valign="bottom">
 121 <tr class="row-odd"><th class="head">Graph</th>
 122 <th class="head">Description</th>
 123 <th class="head">Scale</th>
 124 </tr>
 125 </thead>
 126 <tbody valign="top">
 127 <tr class="row-even"><td>frame-time</td>
 128 <td>Time spent decoding the current frame.</td>
 129 <td>fps/2</td>
 130 </tr>
 131 <tr class="row-odd"><td>sync-time</td>
 132 <td>Time spent waiting for sync.</td>
 133 <td>fps/2</td>
 134 </tr>
 135 <tr class="row-even"><td>tick-time</td>
 136 <td>Time between frames frame.</td>
 137 <td>fps/2</td>
 138 </tr>
 139 </tbody>
 140 </table>
 141 </div>
 142 <div class="section" id="id2">
 143 <h3>1.2.2. Parameters<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
 144 <div class="section" id="device">
 145 <h4>1.2.2.1. DEVICE<a class="headerlink" href="#device" title="Permalink to this headline">¶</a></h4>
 146 <p>Which BlueFish device to attach.</p>
 147 <p>Syntax:</p>
 148 <div class="highlight-python"><pre>[device:int]</pre>
 149 </div>
 150 <p>Configuration Syntax:</p>
 151 <div class="highlight-python"><pre>&lt;device&gt;[1..]&lt;/device&gt;</pre>
 152 </div>
 153 <p>Example:</p>
 154 <div class="highlight-python"><pre>&lt;&lt; ADD 1 BLUEFISH 1</pre>
 155 </div>
 156 </div>
 157 <div class="section" id="embedded-audio">
 158 <h4>1.2.2.2. EMBEDDED_AUDIO<a class="headerlink" href="#embedded-audio" title="Permalink to this headline">¶</a></h4>
 159 <p>Enables embedded-audio.</p>
 160 <p>Syntax:</p>
 161 <div class="highlight-python"><div class="highlight"><pre><span class="n">EMBEDDED_AUDIO</span>
 162 </pre></div>
 163 </div>
 164 <p>Default:</p>
 165 <div class="highlight-python"><div class="highlight"><pre><span class="n">Disabled</span>
 166 </pre></div>
 167 </div>
 168 <p>Configuration Syntax:</p>
 169 <div class="highlight-python"><pre>&lt;embedded-audio&gt;[true|false]&lt;/embedded-audio&gt;</pre>
 170 </div>
 171 <p>Example:</p>
 172 <div class="highlight-python"><pre>&lt;&lt; ADD 1 BLUEFISH 1 EMBEDDED_AUDIO</pre>
 173 </div>
 174 </div>
 175 <div class="section" id="key-only">
 176 <h4>1.2.2.3. KEY_ONLY<a class="headerlink" href="#key-only" title="Permalink to this headline">¶</a></h4>
 177 <p>Displays key as fill.</p>
 178 <p>Default:</p>
 179 <div class="highlight-python"><div class="highlight"><pre><span class="n">Disabled</span>
 180 </pre></div>
 181 </div>
 182 <p>Syntax:</p>
 183 <div class="highlight-python"><div class="highlight"><pre><span class="n">KEY_ONLY</span>
 184 </pre></div>
 185 </div>
 186 <p>Configuration Syntax:</p>
 187 <div class="highlight-python"><pre>&lt;key-only&gt;[true|false]&lt;/key-only&gt;</pre>
 188 </div>
 189 <p>Example:</p>
 190 <div class="highlight-python"><pre>&lt;&lt; ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY</pre>
 191 </div>
 192 </div>
 193 </div>
 194 </div>
 195 <div class="section" id="decklink-consumer">
 196 <h2>1.3. Decklink Consumer<a class="headerlink" href="#decklink-consumer" title="Permalink to this headline">¶</a></h2>
 197 <div class="section" id="id3">
 198 <h3>1.3.1. Diagnostics<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
 199 <p>ffmpeg[<em>filename</em>]</p>
 200 <table border="1" class="docutils">
 201 <colgroup>
 202 <col width="20%" />
 203 <col width="62%" />
 204 <col width="18%" />
 205 </colgroup>
 206 <thead valign="bottom">
 207 <tr class="row-odd"><th class="head">Graph</th>
 208 <th class="head">Description</th>
 209 <th class="head">Scale</th>
 210 </tr>
 211 </thead>
 212 <tbody valign="top">
 213 <tr class="row-even"><td>frame-time</td>
 214 <td>Time spent decoding the current frame.</td>
 215 <td>fps/2</td>
 216 </tr>
 217 <tr class="row-odd"><td>sync-time</td>
 218 <td>Time spent waiting for sync.</td>
 219 <td>fps/2</td>
 220 </tr>
 221 <tr class="row-even"><td>tick-time</td>
 222 <td>Time between frames frame.</td>
 223 <td>fps/2</td>
 224 </tr>
 225 <tr class="row-odd"><td>dropped-frame</td>
 226 <td>Frame was dropped.</td>
 227 <td>N/A</td>
 228 </tr>
 229 <tr class="row-even"><td>late-frame</td>
 230 <td>Frame was late.</td>
 231 <td>N/A</td>
 232 </tr>
 233 <tr class="row-odd"><td>buffered-video</td>
 234 <td>Frame was dropped.</td>
 235 <td>fps</td>
 236 </tr>
 237 <tr class="row-even"><td>buffered-audio</td>
 238 <td>Frame was late.</td>
 239 <td>cadence*2</td>
 240 </tr>
 241 </tbody>
 242 </table>
 243 </div>
 244 <div class="section" id="id4">
 245 <h3>1.3.2. Parameters<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
 246 <div class="section" id="id5">
 247 <h4>1.3.2.1. DEVICE<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
 248 <p>Which BlueFish device to attach.</p>
 249 <p>Syntax:</p>
 250 <div class="highlight-python"><pre>[device:int]</pre>
 251 </div>
 252 <p>Configuration Syntax:</p>
 253 <div class="highlight-python"><pre>&lt;device&gt;[1..]&lt;/device&gt;</pre>
 254 </div>
 255 <p>Example:</p>
 256 <div class="highlight-python"><pre>&lt;&lt; ADD 1 BLUEFISH 1</pre>
 257 </div>
 258 </div>
 259 <div class="section" id="id6">
 260 <h4>1.3.2.2. EMBEDDED_AUDIO<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
 261 <p>Enables embedded-audio.</p>
 262 <p>Syntax:</p>
 263 <div class="highlight-python"><div class="highlight"><pre><span class="n">EMBEDDED_AUDIO</span>
 264 </pre></div>
 265 </div>
 266 <p>Default:</p>
 267 <div class="highlight-python"><div class="highlight"><pre><span class="n">Disabled</span>
 268 </pre></div>
 269 </div>
 270 <p>Configuration Syntax:</p>
 271 <div class="highlight-python"><pre>&lt;embedded-audio&gt;[true|false]&lt;/embedded-audio&gt;</pre>
 272 </div>
 273 <p>Example:</p>
 274 <div class="highlight-python"><pre>&lt;&lt; ADD 1 BLUEFISH 1 EMBEDDED_AUDIO</pre>
 275 </div>
 276 </div>
 277 <div class="section" id="id7">
 278 <h4>1.3.2.3. KEY_ONLY<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
 279 <p>Displays key as fill.</p>
 280 <p>Default:</p>
 281 <div class="highlight-python"><div class="highlight"><pre><span class="n">Disabled</span>
 282 </pre></div>
 283 </div>
 284 <p>Syntax:</p>
 285 <div class="highlight-python"><div class="highlight"><pre><span class="n">KEY_ONLY</span>
 286 </pre></div>
 287 </div>
 288 <p>Configuration Syntax:</p>
 289 <div class="highlight-python"><pre>&lt;key-only&gt;[true|false]&lt;/key-only&gt;</pre>
 290 </div>
 291 <p>Example:</p>
 292 <div class="highlight-python"><pre>&lt;&lt; ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY</pre>
 293 </div>
 294 </div>
 295 <div class="section" id="latency">
 296 <h4>1.3.2.4. LATENCY<a class="headerlink" href="#latency" title="Permalink to this headline">¶</a></h4>
 297 <p>Set latency mode.</p>
 298 <p>Default:</p>
 299 <div class="highlight-python"><div class="highlight"><pre><span class="n">normal</span>
 300 </pre></div>
 301 </div>
 302 <p>Configuration Syntax:</p>
 303 <div class="highlight-python"><pre>&lt;latency&gt;[normal|low|default]&lt;/latency&gt;</pre>
 304 </div>
 305 </div>
 306 <div class="section" id="keyer">
 307 <h4>1.3.2.5. KEYER<a class="headerlink" href="#keyer" title="Permalink to this headline">¶</a></h4>
 308 <p>Set keyer mode.</p>
 309 <p>Default:</p>
 310 <div class="highlight-python"><div class="highlight"><pre><span class="n">external</span>
 311 </pre></div>
 312 </div>
 313 <p>Configuration Syntax:</p>
 314 <div class="highlight-python"><pre>&lt;keyer&gt;[external|internal|default]&lt;/keyer&gt;</pre>
 315 </div>
 316 </div>
 317 <div class="section" id="buffer-depth">
 318 <h4>1.3.2.6. BUFFER_DEPTH<a class="headerlink" href="#buffer-depth" title="Permalink to this headline">¶</a></h4>
 319 <p>Set buffer depth. Settings this value to low can cause output distortion.</p>
 320 <p>Default:</p>
 321 <div class="highlight-python"><div class="highlight"><pre><span class="mi">3</span>
 322 </pre></div>
 323 </div>
 324 <p>Configuration Syntax:</p>
 325 <div class="highlight-python"><pre>&lt;buffer-depth&gt;[1..]&lt;/buffer-depth&gt;</pre>
 326 </div>
 327 </div>
 328 </div>
 329 </div>
 330 <div class="section" id="screen-consumer">
 331 <h2>1.4. Screen Consumer<a class="headerlink" href="#screen-consumer" title="Permalink to this headline">¶</a></h2>
 332 </div>
 333 <div class="section" id="system-audio-consumer">
 334 <h2>1.5. System Audio Consumer<a class="headerlink" href="#system-audio-consumer" title="Permalink to this headline">¶</a></h2>
 335 </div>
 336 </div>
 337
 338
 339           </div>
 340         </div>
 341       </div>
 342       <div class="sphinxsidebar">
 343         <div class="sphinxsidebarwrapper">
 344   <h3><a href="../contents.html">Table Of Contents</a></h3>
 345   <ul>
 346 <li><a class="reference internal" href="#">1. Consumers</a><ul>
 347 <li><a class="reference internal" href="#file-consumer">1.1. File Consumer</a><ul>
 348 <li><a class="reference internal" href="#diagnostics">1.1.1. Diagnostics</a></li>
 349 <li><a class="reference internal" href="#parameters">1.1.2. Parameters</a><ul>
 350 <li><a class="reference internal" href="#filename">1.1.2.1. FILENAME</a></li>
 351 </ul>
 352 </li>
 353 </ul>
 354 </li>
 355 <li><a class="reference internal" href="#bluefish-consumer">1.2. Bluefish Consumer</a><ul>
 356 <li><a class="reference internal" href="#id1">1.2.1. Diagnostics</a></li>
 357 <li><a class="reference internal" href="#id2">1.2.2. Parameters</a><ul>
 358 <li><a class="reference internal" href="#device">1.2.2.1. DEVICE</a></li>
 359 <li><a class="reference internal" href="#embedded-audio">1.2.2.2. EMBEDDED_AUDIO</a></li>
 360 <li><a class="reference internal" href="#key-only">1.2.2.3. KEY_ONLY</a></li>
 361 </ul>
 362 </li>
 363 </ul>
 364 </li>
 365 <li><a class="reference internal" href="#decklink-consumer">1.3. Decklink Consumer</a><ul>
 366 <li><a class="reference internal" href="#id3">1.3.1. Diagnostics</a></li>
 367 <li><a class="reference internal" href="#id4">1.3.2. Parameters</a><ul>
 368 <li><a class="reference internal" href="#id5">1.3.2.1. DEVICE</a></li>
 369 <li><a class="reference internal" href="#id6">1.3.2.2. EMBEDDED_AUDIO</a></li>
 370 <li><a class="reference internal" href="#id7">1.3.2.3. KEY_ONLY</a></li>
 371 <li><a class="reference internal" href="#latency">1.3.2.4. LATENCY</a></li>
 372 <li><a class="reference internal" href="#keyer">1.3.2.5. KEYER</a></li>
 373 <li><a class="reference internal" href="#buffer-depth">1.3.2.6. BUFFER_DEPTH</a></li>
 374 </ul>
 375 </li>
 376 </ul>
 377 </li>
 378 <li><a class="reference internal" href="#screen-consumer">1.4. Screen Consumer</a></li>
 379 <li><a class="reference internal" href="#system-audio-consumer">1.5. System Audio Consumer</a></li>
 380 </ul>
 381 </li>
 382 </ul>
 383
 384   <h4>Previous topic</h4>
 385   <p class="topless"><a href="index.html"
 386                         title="previous chapter">Consumers</a></p>
 387   <h4>Next topic</h4>
 388   <p class="topless"><a href="../faq/index.html"
 389                         title="next chapter">CasparCG Frequently Asked Questions</a></p>
 390 <h3>This Page</h3>
 391 <ul class="this-page-menu">
 392   <li><a href="../bugs.html">Report a Bug</a></li>
 393   <li><a href="../_sources/consumers/consumers.txt"
 394          rel="nofollow">Show Source</a></li>
 395 </ul>
 396
 397 <div id="searchbox" style="display: none">
 398   <h3>Quick search</h3>
 399     <form class="search" action="../search.html" method="get">
 400       <input type="text" name="q" />
 401       <input type="submit" value="Go" />
 402       <input type="hidden" name="check_keywords" value="yes" />
 403       <input type="hidden" name="area" value="default" />
 404     </form>
 405     <p class="searchtip" style="font-size: 90%">
 406     Enter search terms or a module, class or function name.
 407     </p>
 408 </div>
 409 <script type="text/javascript">$('#searchbox').show(0);</script>
 410         </div>
 411       </div>
 412       <div class="clearer"></div>
 413     </div>
 414     <div class="related">
 415       <h3>Navigation</h3>
 416       <ul>
 417         <li class="right" style="margin-right: 10px">
 418           <a href="../genindex.html" title="General Index"
 419              >index</a></li>
 420         <li class="right" >
 421           <a href="../faq/index.html" title="CasparCG Frequently Asked Questions"
 422              >next</a> |</li>
 423         <li class="right" >
 424           <a href="index.html" title="Consumers"
 425              >previous</a> |</li>
 426         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 427
 428           <li><a href="index.html" >Consumers</a> &raquo;</li>
 429       </ul>
 430     </div>
 431     <div class="footer">
 432     &copy; <a href="../copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 433     <br />
 434     <a href="http://www.python.org/psf/donations/">Please donate.</a>
 435     <br />
 436     Last updated on Mar 11, 2012.
 437     <a href="../bugs.html">Found a bug</a>?
 438     <br />
 439     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 440     </div>
 441
 442   </body>
 443 </html>