git.sesse.net Git - casparcg/blob - build/html/amcp/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>9. 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     <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="10. Misc Commands" href="misc-commands.html" />
  37     <link rel="prev" title="8. Mixer Commands" href="mixer-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="misc-commands.html" title="10. Misc Commands"
  50              accesskey="N">next</a> |</li>
  51         <li class="right" >
  52           <a href="mixer-commands.html" title="8. Mixer 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="query-commands">
  66 <h1>9. Query Commands<a class="headerlink" href="#query-commands" title="Permalink to this headline">¶</a></h1>
  67 <div class="section" id="cinf">
  68 <h2>9.1. CINF<a class="headerlink" href="#cinf" title="Permalink to this headline">¶</a></h2>
  69 <p>Returns information about a mediafile.</p>
  70 <p>Syntax:</p>
  71 <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>
  72 </pre></div>
  73 </div>
  74 <p>Example:</p>
  75 <div class="highlight-python"><pre>&gt;&gt; CINF movie
  76 &lt;&lt; ...</pre>
  77 </div>
  78 </div>
  79 <div class="section" id="cls">
  80 <h2>9.2. CLS<a class="headerlink" href="#cls" title="Permalink to this headline">¶</a></h2>
  81 <p>Lists all media files.</p>
  82 <p>Syntax:</p>
  83 <div class="highlight-python"><div class="highlight"><pre><span class="n">CLS</span>
  84 </pre></div>
  85 </div>
  86 <p>Example:</p>
  87 <div class="highlight-python"><pre>&gt;&gt; CLS
  88 &lt;&lt; ...</pre>
  89 </div>
  90 </div>
  91 <div class="section" id="tls">
  92 <h2>9.3. TLS<a class="headerlink" href="#tls" title="Permalink to this headline">¶</a></h2>
  93 <p>Lists all template files.</p>
  94 <p>Syntax:</p>
  95 <div class="highlight-python"><div class="highlight"><pre><span class="n">TLS</span>
  96 </pre></div>
  97 </div>
  98 <p>Example:</p>
  99 <div class="highlight-python"><pre>&gt;&gt; TLS
 100 &lt;&lt; ...</pre>
 101 </div>
 102 </div>
 103 <div class="section" id="version">
 104 <h2>9.4. VERSION<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h2>
 105 <p>Returns the version of specified component.</p>
 106 <p>Syntax:</p>
 107 <div class="highlight-python"><pre>    VERSION SERVER
 108 VERSION FLASH
 109 VERSION TEMPLATEHOST</pre>
 110 </div>
 111 <p>Example:</p>
 112 <div class="highlight-python"><pre>&gt;&gt; VERSION
 113 &lt;&lt; ...
 114 &gt;&gt; VERSION FLASH
 115 &lt;&lt; ...</pre>
 116 </div>
 117 </div>
 118 <div class="section" id="info">
 119 <h2>9.5. INFO<a class="headerlink" href="#info" title="Permalink to this headline">¶</a></h2>
 120 <p>Returns xml-formatted information about the server.</p>
 121 <p>INFO TEMPLATE:  Reads meta-data from a flash-template.
 122 INFO PATHS:     Returns configured paths.
 123 INFO SYSTEM:    Returns information about the system.
 124 INFO CONFIG:    Return the configuration.
 125 INFO:           Returns a list of channels (not xml-formatted due to compatibility issues with older clients).
 126 INFO 1:         Returns information about specified channl.
 127 INFO 1-1:       Returns information about specified layer.
 128 CG 1 INFO       Returns information about flash-producer running on specified channel.</p>
 129 <p>Syntax:</p>
 130 <div class="highlight-python"><pre>INFO TEMPLATE [filename:string]
 131 INFO PATHS
 132 INFO SYSTEM
 133 INFO CONFIG
 134 INFO
 135 INFO [channel:int]
 136 INFO [channel:int]-[layer:int]
 137 CG [channel:int] INFO</pre>
 138 </div>
 139 <p>Example:</p>
 140 <div class="highlight-python"><pre>&gt;&gt; INFO
 141 &lt;&lt; ...
 142 &gt;&gt; INFO 1
 143 &lt;&lt; ...
 144 &gt;&gt; INFO 1-1
 145 &lt;&lt; ...
 146 &gt;&gt; INFO TEMPLATE my_table_template
 147 &lt;&lt; ...</pre>
 148 </div>
 149 </div>
 150 </div>
 151
 152
 153           </div>
 154         </div>
 155       </div>
 156       <div class="sphinxsidebar">
 157         <div class="sphinxsidebarwrapper">
 158   <h3><a href="../contents.html">Table Of Contents</a></h3>
 159   <ul>
 160 <li><a class="reference internal" href="#">9. Query Commands</a><ul>
 161 <li><a class="reference internal" href="#cinf">9.1. CINF</a></li>
 162 <li><a class="reference internal" href="#cls">9.2. CLS</a></li>
 163 <li><a class="reference internal" href="#tls">9.3. TLS</a></li>
 164 <li><a class="reference internal" href="#version">9.4. VERSION</a></li>
 165 <li><a class="reference internal" href="#info">9.5. INFO</a></li>
 166 </ul>
 167 </li>
 168 </ul>
 169
 170   <h4>Previous topic</h4>
 171   <p class="topless"><a href="mixer-commands.html"
 172                         title="previous chapter">8. Mixer Commands</a></p>
 173   <h4>Next topic</h4>
 174   <p class="topless"><a href="misc-commands.html"
 175                         title="next chapter">10. Misc Commands</a></p>
 176 <h3>This Page</h3>
 177 <ul class="this-page-menu">
 178   <li><a href="../bugs.html">Report a Bug</a></li>
 179   <li><a href="../_sources/amcp/query-commands.txt"
 180          rel="nofollow">Show Source</a></li>
 181 </ul>
 182
 183 <div id="searchbox" style="display: none">
 184   <h3>Quick search</h3>
 185     <form class="search" action="../search.html" method="get">
 186       <input type="text" name="q" />
 187       <input type="submit" value="Go" />
 188       <input type="hidden" name="check_keywords" value="yes" />
 189       <input type="hidden" name="area" value="default" />
 190     </form>
 191     <p class="searchtip" style="font-size: 90%">
 192     Enter search terms or a module, class or function name.
 193     </p>
 194 </div>
 195 <script type="text/javascript">$('#searchbox').show(0);</script>
 196         </div>
 197       </div>
 198       <div class="clearer"></div>
 199     </div>
 200     <div class="related">
 201       <h3>Navigation</h3>
 202       <ul>
 203         <li class="right" style="margin-right: 10px">
 204           <a href="../genindex.html" title="General Index"
 205              >index</a></li>
 206         <li class="right" >
 207           <a href="misc-commands.html" title="10. Misc Commands"
 208              >next</a> |</li>
 209         <li class="right" >
 210           <a href="mixer-commands.html" title="8. Mixer Commands"
 211              >previous</a> |</li>
 212         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 213
 214           <li><a href="index.html" >AMCP 2.0 Reference</a> &raquo;</li>
 215       </ul>
 216     </div>
 217     <div class="footer">
 218     &copy; <a href="../copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 219     <br />
 220     Last updated on Mar 13, 2012.
 221     <a href="../bugs.html">Found a bug</a>?
 222     <br />
 223     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 224     </div>
 225
 226   </body>
 227 </html>