Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="module-al-constants.html" /> | |
13 | <link rel="prev" href="sgi.html" /> | |
14 | <link rel="parent" href="sgi.html" /> | |
15 | <link rel="next" href="al-config-objects.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>20.1 al -- Audio functions on the SGI</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="20. SGI IRIX Specific" | |
25 | href="sgi.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="20. SGI IRIX Specific" | |
28 | href="sgi.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="20.1.1 Configuration Objects" | |
31 | href="al-config-objects.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python Library Reference</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="sgi.html">20. SGI IRIX Specific</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="sgi.html">20. SGI IRIX Specific</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="al-config-objects.html">20.1.1 Configuration Objects</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H1><A NAME="SECTION0022100000000000000000"> | |
56 | 20.1 <tt class="module">al</tt> -- | |
57 | Audio functions on the SGI</A> | |
58 | </H1> | |
59 | ||
60 | <P> | |
61 | <A NAME="module-al"></A> | |
62 | <p class="availability">Availability: <span | |
63 | class="platform">IRIX</span>.</p> | |
64 | ||
65 | <P> | |
66 | This module provides access to the audio facilities of the SGI Indy | |
67 | and Indigo workstations. See section 3A of the IRIX man pages for | |
68 | details. You'll need to read those man pages to understand what these | |
69 | functions do! Some of the functions are not available in IRIX | |
70 | releases before 4.0.5. Again, see the manual to check whether a | |
71 | specific function is available on your platform. | |
72 | ||
73 | <P> | |
74 | All functions and methods defined in this module are equivalent to | |
75 | the C functions with "<tt class="samp">AL</tt>" prefixed to their name. | |
76 | ||
77 | <P> | |
78 | Symbolic constants from the C header file <code><audio.h></code> are | |
79 | defined in the standard module | |
80 | <tt class="module"><a href="module-al-constants.html">AL</a></tt><a id='l2h-5043' xml:id='l2h-5043'></a>, see below. | |
81 | ||
82 | <P> | |
83 | <span class="warning"><b class="label">Warning:</b> | |
84 | The current version of the audio library may dump core | |
85 | when bad argument values are passed rather than returning an error | |
86 | status. Unfortunately, since the precise circumstances under which | |
87 | this may happen are undocumented and hard to check, the Python | |
88 | interface can provide no protection against this kind of problems. | |
89 | (One example is specifying an excessive queue size -- there is no | |
90 | documented upper limit.)</span> | |
91 | ||
92 | <P> | |
93 | The module defines the following functions: | |
94 | ||
95 | <P> | |
96 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
97 | <td><nobr><b><tt id='l2h-5038' xml:id='l2h-5038' class="function">openport</tt></b>(</nobr></td> | |
98 | <td><var>name, direction</var><big>[</big><var>, config</var><big>]</big><var></var>)</td></tr></table></dt> | |
99 | <dd> | |
100 | The name and direction arguments are strings. The optional | |
101 | <var>config</var> argument is a configuration object as returned by | |
102 | <tt class="function">newconfig()</tt>. The return value is an <i class="dfn">audio port | |
103 | object</i>; methods of audio port objects are described below. | |
104 | </dl> | |
105 | ||
106 | <P> | |
107 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
108 | <td><nobr><b><tt id='l2h-5039' xml:id='l2h-5039' class="function">newconfig</tt></b>(</nobr></td> | |
109 | <td><var></var>)</td></tr></table></dt> | |
110 | <dd> | |
111 | The return value is a new <i class="dfn">audio configuration object</i>; methods of | |
112 | audio configuration objects are described below. | |
113 | </dl> | |
114 | ||
115 | <P> | |
116 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
117 | <td><nobr><b><tt id='l2h-5040' xml:id='l2h-5040' class="function">queryparams</tt></b>(</nobr></td> | |
118 | <td><var>device</var>)</td></tr></table></dt> | |
119 | <dd> | |
120 | The device argument is an integer. The return value is a list of | |
121 | integers containing the data returned by <tt class="cfunction">ALqueryparams()</tt>. | |
122 | </dl> | |
123 | ||
124 | <P> | |
125 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
126 | <td><nobr><b><tt id='l2h-5041' xml:id='l2h-5041' class="function">getparams</tt></b>(</nobr></td> | |
127 | <td><var>device, list</var>)</td></tr></table></dt> | |
128 | <dd> | |
129 | The <var>device</var> argument is an integer. The list argument is a list | |
130 | such as returned by <tt class="function">queryparams()</tt>; it is modified in place | |
131 | (!). | |
132 | </dl> | |
133 | ||
134 | <P> | |
135 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
136 | <td><nobr><b><tt id='l2h-5042' xml:id='l2h-5042' class="function">setparams</tt></b>(</nobr></td> | |
137 | <td><var>device, list</var>)</td></tr></table></dt> | |
138 | <dd> | |
139 | The <var>device</var> argument is an integer. The <var>list</var> argument is a | |
140 | list such as returned by <tt class="function">queryparams()</tt>. | |
141 | </dl> | |
142 | ||
143 | <P> | |
144 | ||
145 | <p><br /></p><hr class='online-navigation' /> | |
146 | <div class='online-navigation'> | |
147 | <!--Table of Child-Links--> | |
148 | <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a> | |
149 | ||
150 | <UL CLASS="ChildLinks"> | |
151 | <LI><A href="al-config-objects.html">20.1.1 Configuration Objects</a> | |
152 | <LI><A href="al-port-objects.html">20.1.2 Port Objects</a> | |
153 | </ul> | |
154 | <!--End of Table of Child-Links--> | |
155 | </div> | |
156 | ||
157 | <DIV CLASS="navigation"> | |
158 | <div class='online-navigation'> | |
159 | <p></p><hr /> | |
160 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
161 | <tr> | |
162 | <td class='online-navigation'><a rel="prev" title="20. SGI IRIX Specific" | |
163 | href="sgi.html"><img src='../icons/previous.png' | |
164 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
165 | <td class='online-navigation'><a rel="parent" title="20. SGI IRIX Specific" | |
166 | href="sgi.html"><img src='../icons/up.png' | |
167 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
168 | <td class='online-navigation'><a rel="next" title="20.1.1 Configuration Objects" | |
169 | href="al-config-objects.html"><img src='../icons/next.png' | |
170 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
171 | <td align="center" width="100%">Python Library Reference</td> | |
172 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
173 | href="contents.html"><img src='../icons/contents.png' | |
174 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
175 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
176 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
177 | <td class='online-navigation'><a rel="index" title="Index" | |
178 | href="genindex.html"><img src='../icons/index.png' | |
179 | border='0' height='32' alt='Index' width='32' /></A></td> | |
180 | </tr></table> | |
181 | <div class='online-navigation'> | |
182 | <b class="navlabel">Previous:</b> | |
183 | <a class="sectref" rel="prev" href="sgi.html">20. SGI IRIX Specific</A> | |
184 | <b class="navlabel">Up:</b> | |
185 | <a class="sectref" rel="parent" href="sgi.html">20. SGI IRIX Specific</A> | |
186 | <b class="navlabel">Next:</b> | |
187 | <a class="sectref" rel="next" href="al-config-objects.html">20.1.1 Configuration Objects</A> | |
188 | </div> | |
189 | </div> | |
190 | <hr /> | |
191 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
192 | </DIV> | |
193 | <!--End of Navigation Panel--> | |
194 | <ADDRESS> | |
195 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
196 | </ADDRESS> | |
197 | </BODY> | |
198 | </HTML> |