Edit File: al.html
<!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="Content-Type" content="text/html; charset=utf-8" /> <title>38.1. al — Audio functions on the SGI — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="38. SGI IRIX Specific Services" href="sgi.html" /> <link rel="next" title="38.3. cd — CD-ROM access on SGI systems" href="cd.html" /> <link rel="prev" title="38. SGI IRIX Specific Services" href="sgi.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="cd.html" title="38.3. cd — CD-ROM access on SGI systems" accesskey="N">next</a> |</li> <li class="right" > <a href="sgi.html" title="38. SGI IRIX Specific Services" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="sgi.html" accesskey="U">38. SGI IRIX Specific Services</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-al"> <span id="al-audio-functions-on-the-sgi"></span><h1>38.1. <a class="reference internal" href="#module-al" title="al: Audio functions on the SGI. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">al</span></tt></a> — Audio functions on the SGI<a class="headerlink" href="#module-al" title="Permalink to this headline">¶</a></h1> <p class="deprecated"> <span class="versionmodified">Deprecated since version 2.6: </span>The <a class="reference internal" href="#module-al" title="al: Audio functions on the SGI. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">al</span></tt></a> module has been removed in Python 3.</p> <p>This module provides access to the audio facilities of the SGI Indy and Indigo workstations. See section 3A of the IRIX man pages for details. You’ll need to read those man pages to understand what these functions do! Some of the functions are not available in IRIX releases before 4.0.5. Again, see the manual to check whether a specific function is available on your platform.</p> <p>All functions and methods defined in this module are equivalent to the C functions with <tt class="docutils literal"><span class="pre">AL</span></tt> prefixed to their name.</p> <p id="index-0">Symbolic constants from the C header file <tt class="docutils literal"><span class="pre"><audio.h></span></tt> are defined in the standard module <a class="reference internal" href="#module-AL" title="AL: Constants used with the al module. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">AL</span></tt></a>, see below.</p> <div class="admonition warning"> <p class="first admonition-title">Warning</p> <p class="last">The current version of the audio library may dump core when bad argument values are passed rather than returning an error status. Unfortunately, since the precise circumstances under which this may happen are undocumented and hard to check, the Python interface can provide no protection against this kind of problems. (One example is specifying an excessive queue size — there is no documented upper limit.)</p> </div> <p>The module defines the following functions:</p> <dl class="function"> <dt id="al.openport"> <tt class="descclassname">al.</tt><tt class="descname">openport</tt><big>(</big><em>name</em>, <em>direction</em><span class="optional">[</span>, <em>config</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#al.openport" title="Permalink to this definition">¶</a></dt> <dd><p>The name and direction arguments are strings. The optional <em>config</em> argument is a configuration object as returned by <a class="reference internal" href="#al.newconfig" title="al.newconfig"><tt class="xref py py-func docutils literal"><span class="pre">newconfig()</span></tt></a>. The return value is an <em class="dfn">audio port object</em>; methods of audio port objects are described below.</p> </dd></dl> <dl class="function"> <dt id="al.newconfig"> <tt class="descclassname">al.</tt><tt class="descname">newconfig</tt><big>(</big><big>)</big><a class="headerlink" href="#al.newconfig" title="Permalink to this definition">¶</a></dt> <dd><p>The return value is a new <em class="dfn">audio configuration object</em>; methods of audio configuration objects are described below.</p> </dd></dl> <dl class="function"> <dt id="al.queryparams"> <tt class="descclassname">al.</tt><tt class="descname">queryparams</tt><big>(</big><em>device</em><big>)</big><a class="headerlink" href="#al.queryparams" title="Permalink to this definition">¶</a></dt> <dd><p>The device argument is an integer. The return value is a list of integers containing the data returned by <tt class="xref c c-func docutils literal"><span class="pre">ALqueryparams()</span></tt>.</p> </dd></dl> <dl class="function"> <dt id="al.getparams"> <tt class="descclassname">al.</tt><tt class="descname">getparams</tt><big>(</big><em>device</em>, <em>list</em><big>)</big><a class="headerlink" href="#al.getparams" title="Permalink to this definition">¶</a></dt> <dd><p>The <em>device</em> argument is an integer. The list argument is a list such as returned by <a class="reference internal" href="#al.queryparams" title="al.queryparams"><tt class="xref py py-func docutils literal"><span class="pre">queryparams()</span></tt></a>; it is modified in place (!).</p> </dd></dl> <dl class="function"> <dt id="al.setparams"> <tt class="descclassname">al.</tt><tt class="descname">setparams</tt><big>(</big><em>device</em>, <em>list</em><big>)</big><a class="headerlink" href="#al.setparams" title="Permalink to this definition">¶</a></dt> <dd><p>The <em>device</em> argument is an integer. The <em>list</em> argument is a list such as returned by <a class="reference internal" href="#al.queryparams" title="al.queryparams"><tt class="xref py py-func docutils literal"><span class="pre">queryparams()</span></tt></a>.</p> </dd></dl> <div class="section" id="configuration-objects"> <span id="al-config-objects"></span><h2>38.1.1. Configuration Objects<a class="headerlink" href="#configuration-objects" title="Permalink to this headline">¶</a></h2> <p>Configuration objects returned by <a class="reference internal" href="#al.newconfig" title="al.newconfig"><tt class="xref py py-func docutils literal"><span class="pre">newconfig()</span></tt></a> have the following methods:</p> <dl class="method"> <dt> <tt class="descname">audio configuration.getqueuesize()</tt></dt> <dd><p>Return the queue size.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.setqueuesize(size)</tt></dt> <dd><p>Set the queue size.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.getwidth()</tt></dt> <dd><p>Get the sample width.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.setwidth(width)</tt></dt> <dd><p>Set the sample width.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.getchannels()</tt></dt> <dd><p>Get the channel count.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.setchannels(nchannels)</tt></dt> <dd><p>Set the channel count.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.getsampfmt()</tt></dt> <dd><p>Get the sample format.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.setsampfmt(sampfmt)</tt></dt> <dd><p>Set the sample format.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.getfloatmax()</tt></dt> <dd><p>Get the maximum value for floating sample formats.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio configuration.setfloatmax(floatmax)</tt></dt> <dd><p>Set the maximum value for floating sample formats.</p> </dd></dl> </div> <div class="section" id="port-objects"> <span id="al-port-objects"></span><h2>38.1.2. Port Objects<a class="headerlink" href="#port-objects" title="Permalink to this headline">¶</a></h2> <p>Port objects, as returned by <a class="reference internal" href="#al.openport" title="al.openport"><tt class="xref py py-func docutils literal"><span class="pre">openport()</span></tt></a>, have the following methods:</p> <dl class="method"> <dt> <tt class="descname">audio port.closeport()</tt></dt> <dd><p>Close the port.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.getfd()</tt></dt> <dd><p>Return the file descriptor as an int.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.getfilled()</tt></dt> <dd><p>Return the number of filled samples.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.getfillable()</tt></dt> <dd><p>Return the number of fillable samples.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.readsamps(nsamples)</tt></dt> <dd><p>Read a number of samples from the queue, blocking if necessary. Return the data as a string containing the raw data, (e.g., 2 bytes per sample in big-endian byte order (high byte, low byte) if you have set the sample width to 2 bytes).</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.writesamps(samples)</tt></dt> <dd><p>Write samples into the queue, blocking if necessary. The samples are encoded as described for the <tt class="xref py py-meth docutils literal"><span class="pre">readsamps()</span></tt> return value.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.getfillpoint()</tt></dt> <dd><p>Return the ‘fill point’.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.setfillpoint(fillpoint)</tt></dt> <dd><p>Set the ‘fill point’.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.getconfig()</tt></dt> <dd><p>Return a configuration object containing the current configuration of the port.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.setconfig(config)</tt></dt> <dd><p>Set the configuration from the argument, a configuration object.</p> </dd></dl> <dl class="method"> <dt> <tt class="descname">audio port.getstatus(list)</tt></dt> <dd><p>Get status information on last error.</p> </dd></dl> </div> </div> <div class="section" id="module-AL"> <span id="al-constants-used-with-the-al-module"></span><h1>38.2. <a class="reference internal" href="#module-AL" title="AL: Constants used with the al module. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">AL</span></tt></a> — Constants used with the <a class="reference internal" href="#module-al" title="al: Audio functions on the SGI. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">al</span></tt></a> module<a class="headerlink" href="#module-AL" title="Permalink to this headline">¶</a></h1> <p class="deprecated"> <span class="versionmodified">Deprecated since version 2.6: </span>The <a class="reference internal" href="#module-AL" title="AL: Constants used with the al module. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">AL</span></tt></a> module has been removed in Python 3.</p> <p>This module defines symbolic constants needed to use the built-in module <a class="reference internal" href="#module-al" title="al: Audio functions on the SGI. (deprecated) (IRIX)"><tt class="xref py py-mod docutils literal"><span class="pre">al</span></tt></a> (see above); they are equivalent to those defined in the C header file <tt class="docutils literal"><span class="pre"><audio.h></span></tt> except that the name prefix <tt class="docutils literal"><span class="pre">AL_</span></tt> is omitted. Read the module source for a complete list of the defined names. Suggested use:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">al</span> <span class="kn">from</span> <span class="nn">AL</span> <span class="kn">import</span> <span class="o">*</span> </pre></div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">38.1. <tt class="docutils literal"><span class="pre">al</span></tt> — Audio functions on the SGI</a><ul> <li><a class="reference internal" href="#configuration-objects">38.1.1. Configuration Objects</a></li> <li><a class="reference internal" href="#port-objects">38.1.2. Port Objects</a></li> </ul> </li> <li><a class="reference internal" href="#module-AL">38.2. <tt class="docutils literal"><span class="pre">AL</span></tt> — Constants used with the <tt class="docutils literal"><span class="pre">al</span></tt> module</a></li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="sgi.html" title="previous chapter">38. SGI IRIX Specific Services</a></p> <h4>Next topic</h4> <p class="topless"><a href="cd.html" title="next chapter">38.3. <tt class="docutils literal"><span class="pre">cd</span></tt> — CD-ROM access on SGI systems</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/al.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <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> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="cd.html" title="38.3. cd — CD-ROM access on SGI systems" >next</a> |</li> <li class="right" > <a href="sgi.html" title="38. SGI IRIX Specific Services" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="sgi.html" >38. SGI IRIX Specific Services</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>