11\section {Built-in Module \sectcode {al} }
22\bimodindex {al}
33
4- This module provides access to the audio facilities of the Indigo and
5- 4D/35 workstations, described in section 3A of the IRIX 4.0 man pages
6- (and also available as an option in IRIX 3.3). You'll need to read
7- those man pages to understand what these functions do!
8- Some of the functions are not available in releases below 4.0.5.
9- Again, see the manual to check whether a specific function is
10- available on your platform.
4+ This module provides access to the audio facilities of the SGI Indy
5+ and Indigo workstations. See section 3A of the IRIX man pages for
6+ details. You'll need to read those man pages to understand what these
7+ functions do! Some of the functions are not available in IRIX
8+ releases before 4.0.5. Again, see the manual to check whether a
9+ specific function is available on your platform.
10+
11+ All functions and methods defined in this module are equivalent to
12+ the C functions with \samp {AL} prefixed to their name.
1113
1214Symbolic constants from the C header file
\file {<audio.h>} are defined
1315in the standard module \code {AL}, see below.
@@ -20,145 +22,138 @@ \section{Built-in Module \sectcode{al}}
2022(One example is specifying an excessive queue size --- there is no
2123documented upper limit.)
2224
23- Module \code {al} defines the following functions:
25+ The module defines the following functions:
2426
2527\renewcommand {\indexsubitem }{(in module al)}
28+
2629\begin {funcdesc }{openport}{name\, direction\optional {\, config}}
27- Equivalent to the C function ALopenport(). The name and direction
28- arguments are strings. The optional config argument is an opaque
29- configuration object as returned by \code {al.newconfig()}. The return
30- value is an opaque port object; methods of port objects are described
31- below.
30+ The name and direction arguments are strings. The optional config
31+ argument is a configuration object as returned by
32+ \code {al.newconfig()}. The return value is an \dfn {port object};
33+ methods of port objects are described below.
3234\end {funcdesc }
3335
3436\begin {funcdesc }{newconfig}{}
35- Equivalent to the C function ALnewconfig(). The return value is a new
36- opaque configuration object; methods of configuration objects are
37- described below.
37+ The return value is a new \dfn {configuration object}; methods of
38+ configuration objects are described below.
3839\end {funcdesc }
3940
4041\begin {funcdesc }{queryparams}{device}
41- Equivalent to the C function ALqueryparams(). The device argument is
42- an integer. The return value is a list of integers containing the
43- data returned by ALqueryparams().
42+ The device argument is an integer. The return value is a list of
43+ integers containing the data returned by ALqueryparams().
4444\end {funcdesc }
4545
4646\begin {funcdesc }{getparams}{device\, list}
47- Equivalent to the C function ALgetparams(). The device argument is an
48- integer. The list argument is a list such as returned by
49- \code {queryparams}; it is modified in place (!).
47+ The device argument is an integer. The list argument is a list such
48+ as returned by \code {queryparams}; it is modified in place (!).
5049\end {funcdesc }
5150
5251\begin {funcdesc }{setparams}{device\, list}
53- Equivalent to the C function ALsetparams(). The device argument is an
54- integer.The list argument is a list such as returned by
55- \code {al.queryparams}.
52+ The device argument is an integer. The list argument is a list such
53+ as returned by \code {al.queryparams}.
5654\end {funcdesc }
5755
56+ \subsection {Configuration Objects }
57+
5858Configuration objects (returned by \code {al.newconfig()} have the
5959following methods:
6060
6161\renewcommand {\indexsubitem }{(audio configuration object method)}
62+
6263\begin {funcdesc }{getqueuesize}{}
63- Return the queue size; equivalent to the C function ALgetqueuesize() .
64+ Return the queue size.
6465\end {funcdesc }
6566
6667\begin {funcdesc }{setqueuesize}{size}
67- Set the queue size; equivalent to the C function ALsetqueuesize() .
68+ Set the queue size.
6869\end {funcdesc }
6970
7071\begin {funcdesc }{getwidth}{}
71- Get the sample width; equivalent to the C function ALgetwidth() .
72+ Get the sample width.
7273\end {funcdesc }
7374
74- \begin {funcdesc }{getwidth }{width}
75- Set the sample width; equivalent to the C function ALsetwidth() .
75+ \begin {funcdesc }{setwidth }{width}
76+ Set the sample width.
7677\end {funcdesc }
7778
7879\begin {funcdesc }{getchannels}{}
79- Get the channel count; equivalent to the C function ALgetchannels() .
80+ Get the channel count.
8081\end {funcdesc }
8182
8283\begin {funcdesc }{setchannels}{nchannels}
83- Set the channel count; equivalent to the C function ALsetchannels() .
84+ Set the channel count.
8485\end {funcdesc }
8586
8687\begin {funcdesc }{getsampfmt}{}
87- Get the sample format; equivalent to the C function ALgetsampfmt() .
88+ Get the sample format.
8889\end {funcdesc }
8990
9091\begin {funcdesc }{setsampfmt}{sampfmt}
91- Set the sample format; equivalent to the C function ALsetsampfmt() .
92+ Set the sample format.
9293\end {funcdesc }
9394
9495\begin {funcdesc }{getfloatmax}{}
95- Get the maximum value for floating sample formats;
96- equivalent to the C function ALgetfloatmax().
96+ Get the maximum value for floating sample formats.
9797\end {funcdesc }
9898
9999\begin {funcdesc }{setfloatmax}{floatmax}
100- Set the maximum value for floating sample formats;
101- equivalent to the C function ALsetfloatmax().
100+ Set the maximum value for floating sample formats.
102101\end {funcdesc }
103102
103+ \subsection {Port Objects }
104+
104105Port objects (returned by \code {al.openport()} have the following
105106methods:
106107
107108\renewcommand {\indexsubitem }{(audio port object method)}
109+
108110\begin {funcdesc }{closeport}{}
109- Close the port; equivalent to the C function ALcloseport() .
111+ Close the port.
110112\end {funcdesc }
111113
112114\begin {funcdesc }{getfd}{}
113- Return the file descriptor as an int; equivalent to the C function
114- ALgetfd().
115+ Return the file descriptor as an int.
115116\end {funcdesc }
116117
117118\begin {funcdesc }{getfilled}{}
118- Return the number of filled samples; equivalent to the C function
119- ALgetfilled().
119+ Return the number of filled samples.
120120\end {funcdesc }
121121
122122\begin {funcdesc }{getfillable}{}
123- Return the number of fillable samples; equivalent to the C function
124- ALgetfillable().
123+ Return the number of fillable samples.
125124\end {funcdesc }
126125
127126\begin {funcdesc }{readsamps}{nsamples}
128- Read a number of samples from the queue, blocking if necessary;
129- equivalent to the C function ALreadsamples. The data is returned as a
130- string containing the raw data (e.g. 2 bytes per sample in big-endian
131- byte order (high byte, low byte) if you have set the sample width to 2
132- bytes.
127+ Read a number of samples from the queue, blocking if necessary.
128+ Return the data as a string containing the raw data, (e.g., 2 bytes per
129+ sample in big-endian byte order (high byte, low byte) if you have set
130+ the sample width to 2 bytes).
133131\end {funcdesc }
134132
135133\begin {funcdesc }{writesamps}{samples}
136- Write samples into the queue, blocking if necessary; equivalent to the
137- C function ALwritesamples. The samples are encoded as described for
138- the \code {readsamps} return value.
134+ Write samples into the queue, blocking if necessary. The samples are
135+ encoded as described for the \code {readsamps} return value.
139136\end {funcdesc }
140137
141138\begin {funcdesc }{getfillpoint}{}
142- Return the `fill point'; equivalent to the C function ALgetfillpoint() .
139+ Return the `fill point'.
143140\end {funcdesc }
144141
145142\begin {funcdesc }{setfillpoint}{fillpoint}
146- Set the `fill point'; equivalent to the C function ALsetfillpoint() .
143+ Set the `fill point'.
147144\end {funcdesc }
148145
149146\begin {funcdesc }{getconfig}{}
150147Return a configuration object containing the current configuration of
151- the port; equivalent to the C function ALgetconfig() .
148+ the port.
152149\end {funcdesc }
153150
154151\begin {funcdesc }{setconfig}{config}
155- Set the configuration from the argument, a configuration object;
156- equivalent to the C function ALsetconfig().
152+ Set the configuration from the argument, a configuration object.
157153\end {funcdesc }
158154
159155\begin {funcdesc }{getstatus}{list}
160- Get status information on last error
161- equivalent to C function ALgetstatus().
156+ Get status information on last error.
162157\end {funcdesc }
163158
164159\section {Standard Module \sectcode {AL} }
0 commit comments