git.sesse.net Git - casparcg/blob - build/html/amcp/mixer-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>8. Mixer 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="9. Query Commands" href="query-commands.html" />
  37     <link rel="prev" title="7. Data Commands" href="data-commands.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="query-commands.html" title="9. Query Commands"
  50              accesskey="N">next</a> |</li>
  51         <li class="right" >
  52           <a href="data-commands.html" title="7. Data Commands"
  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="mixer-commands">
  66 <h1>8. Mixer Commands<a class="headerlink" href="#mixer-commands" title="Permalink to this headline">¶</a></h1>
  67 <div class="section" id="mixer-keyer">
  68 <h2>8.1. MIXER KEYER<a class="headerlink" href="#mixer-keyer" title="Permalink to this headline">¶</a></h2>
  69 <p>If <em>keyer</em> equals 1 then the specified layer will not be rendered, instead it will be used as the key for the layer above.</p>
  70 <p>Syntax:</p>
  71 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] KEYER [keyer:0|1]</pre>
  72 </div>
  73 <p>Example:</p>
  74 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 KEYER 1</pre>
  75 </div>
  76 </div>
  77 <div class="section" id="mixer-blend">
  78 <h2>8.2. MIXER BLEND<a class="headerlink" href="#mixer-blend" title="Permalink to this headline">¶</a></h2>
  79 <p>Note: Requires &lt;blend-modes&gt; to be actived in casparcg.config.</p>
  80 <p>Syntax:</p>
  81 <div class="highlight-python"><pre>MIXER
  82         [channel:int]-[layer:int] BLEND [blend-mode:string]</pre>
  83 </div>
  84 <p>Example:</p>
  85 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 BLEND overlay</pre>
  86 </div>
  87 <p>See:</p>
  88 <p>Blend-modes.</p>
  89 </div>
  90 <div class="section" id="mixer-opacity">
  91 <h2>8.3. MIXER OPACITY<a class="headerlink" href="#mixer-opacity" title="Permalink to this headline">¶</a></h2>
  92 <p>Syntax:</p>
  93 <div class="highlight-python"><pre>MIXER
  94         [channel:int]-[layer:int] OPACITY [opacity:double] {[tween:string] [duration:int]}</pre>
  95 </div>
  96 <p>Example:</p>
  97 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 OPACITY 0.5</pre>
  98 </div>
  99 </div>
 100 <div class="section" id="mixer-brigthness">
 101 <h2>8.4. MIXER BRIGTHNESS<a class="headerlink" href="#mixer-brigthness" title="Permalink to this headline">¶</a></h2>
 102 <p>Note: Requires &lt;blend-modes&gt; to be actived in casparcg.config.</p>
 103 <p>Syntax:</p>
 104 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] BRIGTHNESS [brightness:double] {[tween:string] [duration:int]}</pre>
 105 </div>
 106 <p>Example:</p>
 107 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 BRIGTHNESS 0.5</pre>
 108 </div>
 109 </div>
 110 <div class="section" id="mixer-saturation">
 111 <h2>8.5. MIXER SATURATION<a class="headerlink" href="#mixer-saturation" title="Permalink to this headline">¶</a></h2>
 112 <p>Note: Requires &lt;blend-modes&gt; to be actived in casparcg.config.</p>
 113 <p>Syntax:</p>
 114 <div class="highlight-python"><pre>MIXER
 115         [channel:int]-[layer:int] SATURATION [saturation:double] {[tween:string] [duration:int]}</pre>
 116 </div>
 117 <p>Example:</p>
 118 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 SATURATION 0.5</pre>
 119 </div>
 120 </div>
 121 <div class="section" id="mixer-contrast">
 122 <h2>8.6. MIXER CONTRAST<a class="headerlink" href="#mixer-contrast" title="Permalink to this headline">¶</a></h2>
 123 <p>Note: Requires &lt;blend-modes&gt; to be actived in casparcg.config.</p>
 124 <p>Syntax:</p>
 125 <div class="highlight-python"><pre>MIXER
 126         [channel:int]-[layer:int] CONTRAST [contrast:double] {[tween:string] [duration:int]}</pre>
 127 </div>
 128 <p>Example:</p>
 129 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 CONTRAST 0.5</pre>
 130 </div>
 131 </div>
 132 <div class="section" id="mixer-levels">
 133 <h2>8.7. MIXER LEVELS<a class="headerlink" href="#mixer-levels" title="Permalink to this headline">¶</a></h2>
 134 <p>Note: Requires &lt;blend-modes&gt; to be actived in casparcg.config.</p>
 135 <p>Syntax:</p>
 136 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] SATURATION [min-input:double] [max-input:double] [gamma:double] [min-output:double] [max-output:double] {[tween:string] [duration:int]}</pre>
 137 </div>
 138 <p>Example:</p>
 139 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 LEVELS 0.1 0.1 1.0 0.9 0.9</pre>
 140 </div>
 141 </div>
 142 <div class="section" id="mixer-fill">
 143 <h2>8.8. MIXER FILL<a class="headerlink" href="#mixer-fill" title="Permalink to this headline">¶</a></h2>
 144 <p>Transforms the video stream on the specified layer.</p>
 145 <p>Syntax:</p>
 146 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] FILL [x:double] [y:double] [x-scale:double] [y-scale:double] {[tween:string] [duration:int]}</pre>
 147 </div>
 148 <p>Example:</p>
 149 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 FILL 0.25 0.25 0.5 0.5</pre>
 150 </div>
 151 </div>
 152 <div class="section" id="mixer-clip">
 153 <h2>8.9. MIXER CLIP<a class="headerlink" href="#mixer-clip" title="Permalink to this headline">¶</a></h2>
 154 <p>Masks the video stream on the specified layer.</p>
 155 <p>Syntax:</p>
 156 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] [x:double] [y:double] [x-scale:double] [y-scale:double] {[tween:string] [duration:int]}</pre>
 157 </div>
 158 <p>Example:</p>
 159 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 CLIP 0.25 0.25 0.5 0.5</pre>
 160 </div>
 161 </div>
 162 <div class="section" id="mixer-grid">
 163 <h2>8.10. MIXER GRID<a class="headerlink" href="#mixer-grid" title="Permalink to this headline">¶</a></h2>
 164 <p>Creates a grid of video streams in ascending order of the layer index, i.e. if resolution equals 2 then a 2x2 grid of layers will be created.</p>
 165 <blockquote>
 166 <div>MIXER [channel:int] GRID [resolution:int]</div></blockquote>
 167 <p>Example:</p>
 168 <div class="highlight-python"><pre>&gt;&gt; MIXER 1 GRID 2</pre>
 169 </div>
 170 </div>
 171 <div class="section" id="mixer-volume">
 172 <h2>8.11. MIXER VOLUME<a class="headerlink" href="#mixer-volume" title="Permalink to this headline">¶</a></h2>
 173 <p>Changes the volume of the specified layer.</p>
 174 <p>Syntax:</p>
 175 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] VOLUME [volume:double] {[tween:string] [duration:int]}</pre>
 176 </div>
 177 <p>Example:</p>
 178 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 VOLUME 0.5</pre>
 179 </div>
 180 </div>
 181 <div class="section" id="mixer-clear">
 182 <h2>8.12. MIXER CLEAR<a class="headerlink" href="#mixer-clear" title="Permalink to this headline">¶</a></h2>
 183 <p>Resets all mixer transforms to identity values.</p>
 184 <p>Note: MIXER BLEND is not reset.</p>
 185 <p>Syntax:</p>
 186 <div class="highlight-python"><pre>MIXER [channel:int]-[layer:int] CLEAR</pre>
 187 </div>
 188 <p>Example:</p>
 189 <div class="highlight-python"><pre>&gt;&gt; MIXER 1-1 CLEAR</pre>
 190 </div>
 191 </div>
 192 </div>
 193
 194
 195           </div>
 196         </div>
 197       </div>
 198       <div class="sphinxsidebar">
 199         <div class="sphinxsidebarwrapper">
 200   <h3><a href="../contents.html">Table Of Contents</a></h3>
 201   <ul>
 202 <li><a class="reference internal" href="#">8. Mixer Commands</a><ul>
 203 <li><a class="reference internal" href="#mixer-keyer">8.1. MIXER KEYER</a></li>
 204 <li><a class="reference internal" href="#mixer-blend">8.2. MIXER BLEND</a></li>
 205 <li><a class="reference internal" href="#mixer-opacity">8.3. MIXER OPACITY</a></li>
 206 <li><a class="reference internal" href="#mixer-brigthness">8.4. MIXER BRIGTHNESS</a></li>
 207 <li><a class="reference internal" href="#mixer-saturation">8.5. MIXER SATURATION</a></li>
 208 <li><a class="reference internal" href="#mixer-contrast">8.6. MIXER CONTRAST</a></li>
 209 <li><a class="reference internal" href="#mixer-levels">8.7. MIXER LEVELS</a></li>
 210 <li><a class="reference internal" href="#mixer-fill">8.8. MIXER FILL</a></li>
 211 <li><a class="reference internal" href="#mixer-clip">8.9. MIXER CLIP</a></li>
 212 <li><a class="reference internal" href="#mixer-grid">8.10. MIXER GRID</a></li>
 213 <li><a class="reference internal" href="#mixer-volume">8.11. MIXER VOLUME</a></li>
 214 <li><a class="reference internal" href="#mixer-clear">8.12. MIXER CLEAR</a></li>
 215 </ul>
 216 </li>
 217 </ul>
 218
 219   <h4>Previous topic</h4>
 220   <p class="topless"><a href="data-commands.html"
 221                         title="previous chapter">7. Data Commands</a></p>
 222   <h4>Next topic</h4>
 223   <p class="topless"><a href="query-commands.html"
 224                         title="next chapter">9. Query Commands</a></p>
 225 <h3>This Page</h3>
 226 <ul class="this-page-menu">
 227   <li><a href="../bugs.html">Report a Bug</a></li>
 228   <li><a href="../_sources/amcp/mixer-commands.txt"
 229          rel="nofollow">Show Source</a></li>
 230 </ul>
 231
 232 <div id="searchbox" style="display: none">
 233   <h3>Quick search</h3>
 234     <form class="search" action="../search.html" method="get">
 235       <input type="text" name="q" />
 236       <input type="submit" value="Go" />
 237       <input type="hidden" name="check_keywords" value="yes" />
 238       <input type="hidden" name="area" value="default" />
 239     </form>
 240     <p class="searchtip" style="font-size: 90%">
 241     Enter search terms or a module, class or function name.
 242     </p>
 243 </div>
 244 <script type="text/javascript">$('#searchbox').show(0);</script>
 245         </div>
 246       </div>
 247       <div class="clearer"></div>
 248     </div>
 249     <div class="related">
 250       <h3>Navigation</h3>
 251       <ul>
 252         <li class="right" style="margin-right: 10px">
 253           <a href="../genindex.html" title="General Index"
 254              >index</a></li>
 255         <li class="right" >
 256           <a href="query-commands.html" title="9. Query Commands"
 257              >next</a> |</li>
 258         <li class="right" >
 259           <a href="data-commands.html" title="7. Data Commands"
 260              >previous</a> |</li>
 261         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 262
 263           <li><a href="index.html" >AMCP 2.0 Reference</a> &raquo;</li>
 264       </ul>
 265     </div>
 266     <div class="footer">
 267     &copy; <a href="../copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 268     <br />
 269     <a href="http://www.python.org/psf/donations/">Please donate.</a>
 270     <br />
 271     Last updated on Mar 13, 2012.
 272     <a href="../bugs.html">Found a bug</a>?
 273     <br />
 274     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 275     </div>
 276
 277   </body>
 278 </html>