git.sesse.net Git - casparcg/blob - build/html/query-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>Query 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     <link rel="top" title="CasparCG 2.0 documentation" href="index.html" />
  29   </head>
  30   <body>
  31     <div class="related">
  32       <h3>Navigation</h3>
  33       <ul>
  34         <li class="right" style="margin-right: 10px">
  35           <a href="genindex.html" title="General Index"
  36              accesskey="I">index</a></li>
  37         <li><a href="index.html">CasparCG 2.0 documentation</a> &raquo;</li>
  38       </ul>
  39     </div>
  40
  41     <div class="document">
  42       <div class="documentwrapper">
  43         <div class="bodywrapper">
  44           <div class="body">
  45
  46   <div class="section" id="query-commands">
  47 <h1>Query Commands<a class="headerlink" href="#query-commands" title="Permalink to this headline">¶</a></h1>
  48 <div class="section" id="cinf">
  49 <h2>CINF<a class="headerlink" href="#cinf" title="Permalink to this headline">¶</a></h2>
  50 <p>Returns information about a mediafile.</p>
  51 <p>Syntax:</p>
  52 <div class="highlight-python"><div class="highlight"><pre><span class="n">CINF</span> <span class="p">[</span><span class="n">filename</span><span class="p">:</span><span class="n">string</span><span class="p">]</span>
  53 </pre></div>
  54 </div>
  55 <p>Example:</p>
  56 <div class="highlight-python"><pre>&gt;&gt; CINF movie
  57 &lt;&lt; ...</pre>
  58 </div>
  59 </div>
  60 <div class="section" id="cls">
  61 <h2>CLS<a class="headerlink" href="#cls" title="Permalink to this headline">¶</a></h2>
  62 <p>Lists all media files.</p>
  63 <p>Syntax:</p>
  64 <div class="highlight-python"><div class="highlight"><pre><span class="n">CLS</span>
  65 </pre></div>
  66 </div>
  67 <p>Example:</p>
  68 <div class="highlight-python"><pre>&gt;&gt; CLS
  69 &lt;&lt; ...</pre>
  70 </div>
  71 </div>
  72 <div class="section" id="tls">
  73 <h2>TLS<a class="headerlink" href="#tls" title="Permalink to this headline">¶</a></h2>
  74 <p>Lists all template files.</p>
  75 <p>Syntax:</p>
  76 <div class="highlight-python"><div class="highlight"><pre><span class="n">TLS</span>
  77 </pre></div>
  78 </div>
  79 <p>Example:</p>
  80 <div class="highlight-python"><pre>&gt;&gt; TLS
  81 &lt;&lt; ...</pre>
  82 </div>
  83 </div>
  84 <div class="section" id="version">
  85 <h2>VERSION<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h2>
  86 <p>Returns the version of specified component.</p>
  87 <p>Syntax:</p>
  88 <div class="highlight-python"><pre>    VERSION SERVER
  89 VERSION FLASH
  90 VERSION TEMPLATEHOST</pre>
  91 </div>
  92 <p>Example:</p>
  93 <div class="highlight-python"><pre>&gt;&gt; VERSION
  94 &lt;&lt; ...
  95 &gt;&gt; VERSION FLASH
  96 &lt;&lt; ...</pre>
  97 </div>
  98 </div>
  99 <div class="section" id="info">
 100 <h2>INFO<a class="headerlink" href="#info" title="Permalink to this headline">¶</a></h2>
 101 <p>Returns xml-formatted information about the server.</p>
 102 <p>INFO TEMPLATE:  Reads meta-data from a flash-template.
 103 INFO PATHS:     Returns configured paths.
 104 INFO SYSTEM:    Returns information about the system.
 105 INFO CONFIG:    Return the configuration.
 106 INFO:           Returns a list of channels (not xml-formatted due to compatibility issues with older clients).
 107 INFO 1:         Returns information about specified channl.
 108 INFO 1-1:       Returns information about specified layer.
 109 CG 1 INFO       Returns information about flash-producer running on specified channel.</p>
 110 <p>Syntax:</p>
 111 <div class="highlight-python"><pre>INFO TEMPLATE [filename:string]
 112 INFO PATHS
 113 INFO SYSTEM
 114 INFO CONFIG
 115 INFO
 116 INFO [channel:int]
 117 INFO [channel:int]-[layer:int]
 118 CG [channel:int] INFO</pre>
 119 </div>
 120 <p>Example:</p>
 121 <div class="highlight-python"><pre>&gt;&gt; INFO
 122 &lt;&lt; ...
 123 &gt;&gt; INFO 1
 124 &lt;&lt; ...
 125 &gt;&gt; INFO 1-1
 126 &lt;&lt; ...
 127 &gt;&gt; INFO TEMPLATE my_table_template
 128 &lt;&lt; ...</pre>
 129 </div>
 130 </div>
 131 </div>
 132
 133
 134           </div>
 135         </div>
 136       </div>
 137       <div class="sphinxsidebar">
 138         <div class="sphinxsidebarwrapper">
 139   <h3><a href="index.html">Table Of Contents</a></h3>
 140   <ul>
 141 <li><a class="reference internal" href="#">Query Commands</a><ul>
 142 <li><a class="reference internal" href="#cinf">CINF</a></li>
 143 <li><a class="reference internal" href="#cls">CLS</a></li>
 144 <li><a class="reference internal" href="#tls">TLS</a></li>
 145 <li><a class="reference internal" href="#version">VERSION</a></li>
 146 <li><a class="reference internal" href="#info">INFO</a></li>
 147 </ul>
 148 </li>
 149 </ul>
 150
 151   <h3>This Page</h3>
 152   <ul class="this-page-menu">
 153     <li><a href="_sources/query-commands.txt"
 154            rel="nofollow">Show Source</a></li>
 155   </ul>
 156 <div id="searchbox" style="display: none">
 157   <h3>Quick search</h3>
 158     <form class="search" action="search.html" method="get">
 159       <input type="text" name="q" />
 160       <input type="submit" value="Go" />
 161       <input type="hidden" name="check_keywords" value="yes" />
 162       <input type="hidden" name="area" value="default" />
 163     </form>
 164     <p class="searchtip" style="font-size: 90%">
 165     Enter search terms or a module, class or function name.
 166     </p>
 167 </div>
 168 <script type="text/javascript">$('#searchbox').show(0);</script>
 169         </div>
 170       </div>
 171       <div class="clearer"></div>
 172     </div>
 173     <div class="related">
 174       <h3>Navigation</h3>
 175       <ul>
 176         <li class="right" style="margin-right: 10px">
 177           <a href="genindex.html" title="General Index"
 178              >index</a></li>
 179         <li><a href="index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 180       </ul>
 181     </div>
 182     <div class="footer">
 183         &copy; Copyright 2011, Robert Nagy.
 184       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 185     </div>
 186   </body>
 187 </html>