git.sesse.net Git - casparcg/blob - build/html/amcp/data-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>7. Data 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 Reference" href="index.html" />
  36     <link rel="next" title="8. Mixer Commands" href="mixer-commands.html" />
  37     <link rel="prev" title="6. Template Graphics Commands" href="template-graphics-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="mixer-commands.html" title="8. Mixer Commands"
  50              accesskey="N">next</a> |</li>
  51         <li class="right" >
  52           <a href="template-graphics-commands.html" title="6. Template Graphics 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 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="data-commands">
  66 <h1>7. Data Commands<a class="headerlink" href="#data-commands" title="Permalink to this headline">¶</a></h1>
  67 <p>The DATA Commands are convenient to use when you have large datasets that might not be available at broadcast-time.
  68 DATA allows you to store a dataset on the CasparCG Server and assign it to a much shorter name. This name can then be used to recall the data when displaying a template graphic.</p>
  69 <div class="section" id="data-store">
  70 <h2>7.1. DATA STORE<a class="headerlink" href="#data-store" title="Permalink to this headline">¶</a></h2>
  71 <p>Stores the dataset data under the name name.</p>
  72 <p>Syntax:</p>
  73 <div class="highlight-python"><pre>DATA STORE [name:string] [data:string]</pre>
  74 </div>
  75 <p>Example:</p>
  76 <div class="highlight-python"><pre>&gt;&gt; DATA STORE my_data "Some useful data"</pre>
  77 </div>
  78 </div>
  79 <div class="section" id="data-retrieve">
  80 <h2>7.2. DATA RETRIEVE<a class="headerlink" href="#data-retrieve" title="Permalink to this headline">¶</a></h2>
  81 <p>Returns the data saved under the name <em>name</em>.</p>
  82 <p>Syntax:</p>
  83 <div class="highlight-python"><pre>DATA RETRIEVE [name:string]</pre>
  84 </div>
  85 <p>Example:</p>
  86 <div class="highlight-python"><pre>&gt;&gt; DATA RETRIEVE my_data
  87 &lt;&lt; "Some usefule data"</pre>
  88 </div>
  89 </div>
  90 <div class="section" id="data-list">
  91 <h2>7.3. DATA LIST<a class="headerlink" href="#data-list" title="Permalink to this headline">¶</a></h2>
  92 <p>Syntax:</p>
  93 <div class="highlight-python"><pre>DATA LIST</pre>
  94 </div>
  95 <p>Example:</p>
  96 <div class="highlight-python"><pre>&gt;&gt; DATA LIST
  97 &lt;&lt; my_data</pre>
  98 </div>
  99 </div>
 100 </div>
 101
 102
 103           </div>
 104         </div>
 105       </div>
 106       <div class="sphinxsidebar">
 107         <div class="sphinxsidebarwrapper">
 108   <h3><a href="../contents.html">Table Of Contents</a></h3>
 109   <ul>
 110 <li><a class="reference internal" href="#">7. Data Commands</a><ul>
 111 <li><a class="reference internal" href="#data-store">7.1. DATA STORE</a></li>
 112 <li><a class="reference internal" href="#data-retrieve">7.2. DATA RETRIEVE</a></li>
 113 <li><a class="reference internal" href="#data-list">7.3. DATA LIST</a></li>
 114 </ul>
 115 </li>
 116 </ul>
 117
 118   <h4>Previous topic</h4>
 119   <p class="topless"><a href="template-graphics-commands.html"
 120                         title="previous chapter">6. Template Graphics Commands</a></p>
 121   <h4>Next topic</h4>
 122   <p class="topless"><a href="mixer-commands.html"
 123                         title="next chapter">8. Mixer Commands</a></p>
 124 <h3>This Page</h3>
 125 <ul class="this-page-menu">
 126   <li><a href="../bugs.html">Report a Bug</a></li>
 127   <li><a href="../_sources/amcp/data-commands.txt"
 128          rel="nofollow">Show Source</a></li>
 129 </ul>
 130
 131 <div id="searchbox" style="display: none">
 132   <h3>Quick search</h3>
 133     <form class="search" action="../search.html" method="get">
 134       <input type="text" name="q" />
 135       <input type="submit" value="Go" />
 136       <input type="hidden" name="check_keywords" value="yes" />
 137       <input type="hidden" name="area" value="default" />
 138     </form>
 139     <p class="searchtip" style="font-size: 90%">
 140     Enter search terms or a module, class or function name.
 141     </p>
 142 </div>
 143 <script type="text/javascript">$('#searchbox').show(0);</script>
 144         </div>
 145       </div>
 146       <div class="clearer"></div>
 147     </div>
 148     <div class="related">
 149       <h3>Navigation</h3>
 150       <ul>
 151         <li class="right" style="margin-right: 10px">
 152           <a href="../genindex.html" title="General Index"
 153              >index</a></li>
 154         <li class="right" >
 155           <a href="mixer-commands.html" title="8. Mixer Commands"
 156              >next</a> |</li>
 157         <li class="right" >
 158           <a href="template-graphics-commands.html" title="6. Template Graphics Commands"
 159              >previous</a> |</li>
 160         <li><a href="../index.html">CasparCG 2.0 documentation</a> &raquo;</li>
 161
 162           <li><a href="index.html" >AMCP Reference</a> &raquo;</li>
 163       </ul>
 164     </div>
 165     <div class="footer">
 166     &copy; <a href="../copyright.html">Copyright</a> 2011, Robert Nagy (ronag89@gmail.com).
 167     <br />
 168     <a href="http://www.python.org/psf/donations/">Please donate.</a>
 169     <br />
 170     Last updated on Mar 11, 2012.
 171     <a href="../bugs.html">Found a bug</a>?
 172     <br />
 173     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
 174     </div>
 175
 176   </body>
 177 </html>