3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7 <html xmlns="http://www.w3.org/1999/xhtml">
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <title>CasparCG Documentation Contents — CasparCG 2.0 documentation</title>
13 <link rel="stylesheet" href="_static/default.css" type="text/css" />
14 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
16 <script type="text/javascript">
17 var DOCUMENTATION_OPTIONS = {
20 COLLAPSE_INDEX: false,
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" />
43 <li class="right" style="margin-right: 10px">
44 <a href="genindex.html" title="General Index"
45 accesskey="I">index</a></li>
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> »</li>
54 <div class="document">
55 <div class="documentwrapper">
56 <div class="bodywrapper">
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">
63 <li class="toctree-l1"><a class="reference internal" href="whatsnew/index.html">What’s New in CasparCG</a><ul>
64 <li class="toctree-l2"><a class="reference internal" href="whatsnew/2_0.html">What’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>
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>
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>
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>
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>
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>
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>
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>
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>
146 <li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">CasparCG Tutorials</a><ul>
147 <li class="toctree-l2"><a class="reference internal" href="tutorial/file-consumer.html">Running the File Consumer</a></li>
150 <li class="toctree-l1"><a class="reference internal" href="producers/index.html">Producers</a><ul>
151 <li class="toctree-l2"><a class="reference internal" href="producers/ffmpeg.html">1. FFMPEG Producer</a><ul>
152 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#supported-media">1.1. Supported Media</a></li>
153 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#filters">1.2. Filters</a></li>
154 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#diagnostics">1.3. Diagnostics</a></li>
155 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#parameters">1.4. Parameters</a><ul>
156 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#loop">1.4.1. LOOP</a></li>
157 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#seek">1.4.2. SEEK</a></li>
158 <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>
159 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#length">1.4.4. LENGTH</a></li>
160 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#filter">1.4.5. FILTER</a></li>
163 <li class="toctree-l3"><a class="reference internal" href="producers/ffmpeg.html#functions">1.5. Functions</a><ul>
164 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#id1">1.5.1. LOOP</a></li>
165 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#id2">1.5.2. SEEK</a></li>
166 <li class="toctree-l4"><a class="reference internal" href="producers/ffmpeg.html#id3">1.5.3. START (CasparCG 2.1)</a></li>
167 <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>
172 <li class="toctree-l2"><a class="reference internal" href="producers/flash.html">2. Flash Producer</a><ul>
173 <li class="toctree-l3"><a class="reference internal" href="producers/flash.html#supported-media">2.1. Supported Media</a></li>
174 <li class="toctree-l3"><a class="reference internal" href="producers/flash.html#diagnostics">2.2. Diagnostics</a></li>
177 <li class="toctree-l2"><a class="reference internal" href="producers/image.html">3. Image Producer</a></li>
178 <li class="toctree-l2"><a class="reference internal" href="producers/image-scroll.html">4. Image Scroll Producer</a></li>
179 <li class="toctree-l2"><a class="reference internal" href="producers/decklink.html">5. Decklink Producer</a><ul>
180 <li class="toctree-l3"><a class="reference internal" href="producers/decklink.html#diagnostics">5.1. Diagnostics</a></li>
181 <li class="toctree-l3"><a class="reference internal" href="producers/decklink.html#parameters">5.2. Parameters</a><ul>
182 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#device">5.2.1. DEVICE</a></li>
183 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#length">5.2.2. LENGTH</a></li>
184 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#filter">5.2.3. FILTER</a></li>
185 <li class="toctree-l4"><a class="reference internal" href="producers/decklink.html#format">5.2.4. FORMAT</a></li>
192 <li class="toctree-l1"><a class="reference internal" href="consumers/index.html">Consumers</a><ul>
193 <li class="toctree-l2"><a class="reference internal" href="consumers/decklink.html">1. Decklink Consumer</a><ul>
194 <li class="toctree-l3"><a class="reference internal" href="consumers/decklink.html#diagnostics">1.1. Diagnostics</a></li>
195 <li class="toctree-l3"><a class="reference internal" href="consumers/decklink.html#parameters">1.2. Parameters</a><ul>
196 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#device">1.2.1. DEVICE</a></li>
197 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#embedded-audio">1.2.2. EMBEDDED_AUDIO</a></li>
198 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#key-only">1.2.3. KEY_ONLY</a></li>
199 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#latency">1.2.4. LATENCY</a></li>
200 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#keyer">1.2.5. KEYER</a></li>
201 <li class="toctree-l4"><a class="reference internal" href="consumers/decklink.html#buffer-depth">1.2.6. BUFFER_DEPTH</a></li>
206 <li class="toctree-l2"><a class="reference internal" href="consumers/bluefish.html">2. Bluefish Consumer</a><ul>
207 <li class="toctree-l3"><a class="reference internal" href="consumers/bluefish.html#diagnostics">2.1. Diagnostics</a></li>
208 <li class="toctree-l3"><a class="reference internal" href="consumers/bluefish.html#parameters">2.2. Parameters</a><ul>
209 <li class="toctree-l4"><a class="reference internal" href="consumers/bluefish.html#device">2.2.1. DEVICE</a></li>
210 <li class="toctree-l4"><a class="reference internal" href="consumers/bluefish.html#embedded-audio">2.2.2. EMBEDDED_AUDIO</a></li>
211 <li class="toctree-l4"><a class="reference internal" href="consumers/bluefish.html#key-only">2.2.3. KEY_ONLY</a></li>
216 <li class="toctree-l2"><a class="reference internal" href="consumers/screen.html">3. Screen Consumer</a></li>
217 <li class="toctree-l2"><a class="reference internal" href="consumers/system-audio.html">4. System Audio Consumer</a></li>
218 <li class="toctree-l2"><a class="reference internal" href="consumers/file.html">5. File Consumer</a><ul>
219 <li class="toctree-l3"><a class="reference internal" href="consumers/file.html#diagnostics">5.1. Diagnostics</a></li>
220 <li class="toctree-l3"><a class="reference internal" href="consumers/file.html#parameters">5.2. Parameters</a><ul>
221 <li class="toctree-l4"><a class="reference internal" href="consumers/file.html#filename">5.2.1. FILENAME</a></li>
226 <li class="toctree-l2"><a class="reference internal" href="consumers/image.html">6. Image Consumer</a></li>
229 <li class="toctree-l1"><a class="reference internal" href="faq/index.html">CasparCG Frequently Asked Questions</a><ul>
230 <li class="toctree-l2"><a class="reference internal" href="faq/general.html">General CasparCG FAQ</a><ul>
231 <li class="toctree-l3"><a class="reference internal" href="faq/general.html#where-can-i-find-the-documentation-for-the-configuration-file-casparcg-config">Where can I find the documentation for the configuration file (casparcg.config)?</a></li>
232 <li class="toctree-l3"><a class="reference internal" href="faq/general.html#when-i-start-casparcg-all-i-get-is-an-empty-console-window">When I start CasparCG all I get is an empty console window?</a></li>
233 <li class="toctree-l3"><a class="reference internal" href="faq/general.html#how-can-i-get-fill-and-key-to-two-separate-outputs-e-g-two-screens">How can I get fill and key to two separate outputs? e.g. two screens.</a></li>
234 <li class="toctree-l3"><a class="reference internal" href="faq/general.html#what-kind-of-transition-animations-are-supported">What kind of transition animations are supported?</a></li>
237 <li class="toctree-l2"><a class="reference internal" href="faq/decklink.html">Decklink FAQ</a><ul>
238 <li class="toctree-l3"><a class="reference internal" href="faq/decklink.html#i-can-t-get-both-input-and-output-to-work-on-my-decklink-card">I can’t get both input and output to work on my Decklink card?</a></li>
239 <li class="toctree-l3"><a class="reference internal" href="faq/decklink.html#how-can-i-get-external-key-using-decklink-quad">How can I get external key using Decklink Quad?</a></li>
240 <li class="toctree-l3"><a class="reference internal" href="faq/decklink.html#what-decklink-cards-support-external-and-internal-key">What Decklink cards support external and internal key?</a></li>
243 <li class="toctree-l2"><a class="reference internal" href="faq/bluefish.html">Bluefish FAQ</a></li>
244 <li class="toctree-l2"><a class="reference internal" href="faq/flash.html">Flash FAQ</a><ul>
245 <li class="toctree-l3"><a class="reference internal" href="faq/flash.html#is-flash-gpu-acceleration-supported">Is Flash GPU acceleration supported?</a></li>
246 <li class="toctree-l3"><a class="reference internal" href="faq/flash.html#is-stage3d-supported">Is Stage3D supported?</a></li>
247 <li class="toctree-l3"><a class="reference internal" href="faq/flash.html#why-isn-t-flash-audio-embedded-into-the-sdi-signal">Why isn’t Flash audio embedded into the SDI signal?</a></li>
252 <li class="toctree-l1"><a class="reference internal" href="about.html">About these documents</a></li>
253 <li class="toctree-l1"><a class="reference internal" href="bugs.html">Reporting Bugs</a></li>
254 <li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
255 <li class="toctree-l1"><a class="reference internal" href="license.html">History and License</a></li>
264 <div class="sphinxsidebar">
265 <div class="sphinxsidebarwrapper">
267 <p class="topless"><a href="whatsnew/index.html"
268 title="next chapter">What’s New in CasparCG</a></p>
270 <ul class="this-page-menu">
271 <li><a href="bugs.html">Report a Bug</a></li>
272 <li><a href="_sources/contents.txt"
273 rel="nofollow">Show Source</a></li>
276 <div id="searchbox" style="display: none">
277 <h3>Quick search</h3>
278 <form class="search" action="search.html" method="get">
279 <input type="text" name="q" />
280 <input type="submit" value="Go" />
281 <input type="hidden" name="check_keywords" value="yes" />
282 <input type="hidden" name="area" value="default" />
284 <p class="searchtip" style="font-size: 90%">
285 Enter search terms or a module, class or function name.
288 <script type="text/javascript">$('#searchbox').show(0);</script>
291 <div class="clearer"></div>
293 <div class="related">
296 <li class="right" style="margin-right: 10px">
297 <a href="genindex.html" title="General Index"
300 <a href="whatsnew/index.html" title="What’s New in CasparCG"
302 <li><a href="index.html">CasparCG 2.0 documentation</a> »</li>
307 © <a href="copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
309 Last updated on Mar 15, 2012.
310 <a href="bugs.html">Found a bug</a>?
312 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.