<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Sequence Entry — audaspace 1.3.0 documentation</title> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Sequence" href="sequence.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> </head><body> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="sequence-entry"> <h1>Sequence Entry<a class="headerlink" href="#sequence-entry" title="Permalink to this headline">¶</a></h1> <dl class="class"> <dt id="aud.SequenceEntry"> <em class="property">class </em><code class="descclassname">aud.</code><code class="descname">SequenceEntry</code><a class="headerlink" href="#aud.SequenceEntry" title="Permalink to this definition">¶</a></dt> <dd><p>SequenceEntry objects represent an entry of a sequenced sound.</p> <dl class="attribute"> <dt id="aud.SequenceEntry.attenuation"> <code class="descname">attenuation</code><a class="headerlink" href="#aud.SequenceEntry.attenuation" title="Permalink to this definition">¶</a></dt> <dd><p>This factor is used for distance based attenuation of the source.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="device.html#aud.Device.distance_model" title="aud.Device.distance_model"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.distance_model</span></code></a></p> </div> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.cone_angle_inner"> <code class="descname">cone_angle_inner</code><a class="headerlink" href="#aud.SequenceEntry.cone_angle_inner" title="Permalink to this definition">¶</a></dt> <dd><p>The opening angle of the inner cone of the source. If the cone values of a source are set there are two (audible) cones with the apex at the <code class="xref py py-attr docutils literal notranslate"><span class="pre">location</span></code> of the source and with infinite height, heading in the direction of the source’s <code class="xref py py-attr docutils literal notranslate"><span class="pre">orientation</span></code>. In the inner cone the volume is normal. Outside the outer cone the volume will be <a class="reference internal" href="#aud.SequenceEntry.cone_volume_outer" title="aud.SequenceEntry.cone_volume_outer"><code class="xref py py-attr docutils literal notranslate"><span class="pre">cone_volume_outer</span></code></a> and in the area between the volume will be interpolated linearly.</p> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.cone_angle_outer"> <code class="descname">cone_angle_outer</code><a class="headerlink" href="#aud.SequenceEntry.cone_angle_outer" title="Permalink to this definition">¶</a></dt> <dd><p>The opening angle of the outer cone of the source.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="#aud.SequenceEntry.cone_angle_inner" title="aud.SequenceEntry.cone_angle_inner"><code class="xref py py-attr docutils literal notranslate"><span class="pre">cone_angle_inner</span></code></a></p> </div> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.cone_volume_outer"> <code class="descname">cone_volume_outer</code><a class="headerlink" href="#aud.SequenceEntry.cone_volume_outer" title="Permalink to this definition">¶</a></dt> <dd><p>The volume outside the outer cone of the source.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="#aud.SequenceEntry.cone_angle_inner" title="aud.SequenceEntry.cone_angle_inner"><code class="xref py py-attr docutils literal notranslate"><span class="pre">cone_angle_inner</span></code></a></p> </div> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.distance_maximum"> <code class="descname">distance_maximum</code><a class="headerlink" href="#aud.SequenceEntry.distance_maximum" title="Permalink to this definition">¶</a></dt> <dd><p>The maximum distance of the source. If the listener is further away the source volume will be 0.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="device.html#aud.Device.distance_model" title="aud.Device.distance_model"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.distance_model</span></code></a></p> </div> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.distance_reference"> <code class="descname">distance_reference</code><a class="headerlink" href="#aud.SequenceEntry.distance_reference" title="Permalink to this definition">¶</a></dt> <dd><p>The reference distance of the source. At this distance the volume will be exactly <code class="xref py py-attr docutils literal notranslate"><span class="pre">volume</span></code>.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="device.html#aud.Device.distance_model" title="aud.Device.distance_model"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.distance_model</span></code></a></p> </div> </dd></dl> <dl class="method"> <dt id="aud.SequenceEntry.move"> <code class="descname">move</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aud.SequenceEntry.move" title="Permalink to this definition">¶</a></dt> <dd><p>Moves the entry.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> <li><strong>begin</strong> (<em>float</em>) – The new start time.</li> <li><strong>end</strong> (<em>float</em>) – The new end time or a negative value if unknown.</li> <li><strong>skip</strong> (<em>float</em>) – How many seconds to skip at the beginning.</li> </ul> </td> </tr> </tbody> </table> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.muted"> <code class="descname">muted</code><a class="headerlink" href="#aud.SequenceEntry.muted" title="Permalink to this definition">¶</a></dt> <dd><p>Whether the entry is muted.</p> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.relative"> <code class="descname">relative</code><a class="headerlink" href="#aud.SequenceEntry.relative" title="Permalink to this definition">¶</a></dt> <dd><p>Whether the source’s location, velocity and orientation is relative or absolute to the listener.</p> </dd></dl> <dl class="method"> <dt id="aud.SequenceEntry.setAnimationData"> <code class="descname">setAnimationData</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aud.SequenceEntry.setAnimationData" title="Permalink to this definition">¶</a></dt> <dd><p>Writes animation data to a sequenced entry.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> <li><strong>type</strong> (<em>int</em>) – The type of animation data.</li> <li><strong>frame</strong> (<em>int</em>) – The frame this data is for.</li> <li><strong>data</strong> (<em>sequence of float</em>) – The data to write.</li> <li><strong>animated</strong> (<em>bool</em>) – Whether the attribute is animated.</li> </ul> </td> </tr> </tbody> </table> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.sound"> <code class="descname">sound</code><a class="headerlink" href="#aud.SequenceEntry.sound" title="Permalink to this definition">¶</a></dt> <dd><p>The sound the entry is representing and will be played in the sequence.</p> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.volume_maximum"> <code class="descname">volume_maximum</code><a class="headerlink" href="#aud.SequenceEntry.volume_maximum" title="Permalink to this definition">¶</a></dt> <dd><p>The maximum volume of the source.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="device.html#aud.Device.distance_model" title="aud.Device.distance_model"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.distance_model</span></code></a></p> </div> </dd></dl> <dl class="attribute"> <dt id="aud.SequenceEntry.volume_minimum"> <code class="descname">volume_minimum</code><a class="headerlink" href="#aud.SequenceEntry.volume_minimum" title="Permalink to this definition">¶</a></dt> <dd><p>The minimum volume of the source.</p> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference internal" href="device.html#aud.Device.distance_model" title="aud.Device.distance_model"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Device.distance_model</span></code></a></p> </div> </dd></dl> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h1 class="logo"><a href="index.html">audaspace</a></h1> <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li> </ul> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="device.html">Device</a></li> <li class="toctree-l1"><a class="reference internal" href="sound.html">Sound</a></li> <li class="toctree-l1"><a class="reference internal" href="handle.html">Handle</a></li> <li class="toctree-l1"><a class="reference internal" href="sequence.html">Sequence</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Sequence Entry</a></li> </ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> <li>Previous: <a href="sequence.html" title="previous chapter">Sequence</a></li> </ul></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="footer"> ©2009-2015, Jörg Müller. | Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.3</a> & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a> | <a href="_sources/sequence_entry.rst.txt" rel="nofollow">Page source</a> </div> </body> </html>