[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / lib / module-sunaudiodev.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-sunaudiodev-constants.html" />
<link rel="prev" href="sunos.html" />
<link rel="parent" href="sunos.html" />
<link rel="next" href="audio-device-objects.html" />
<meta name='aesop' content='information' />
<title>21.1 sunaudiodev -- Access to Sun audio hardware</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="21. SunOS Specific Services"
  href="sunos.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="21. SunOS Specific Services"
  href="sunos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="21.1.1 Audio Device Objects"
  href="audio-device-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="sunos.html">21. SunOS Specific Services</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="sunos.html">21. SunOS Specific Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="audio-device-objects.html">21.1.1 Audio Device Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0023100000000000000000">
21.1 <tt class="module">sunaudiodev</tt> --
         Access to Sun audio hardware</A>
</H1>

<P>
<A NAME="module-sunaudiodev"></A>  
<p class="availability">Availability: <span
 class="platform">SunOS</span>.</p>

<P>
This module allows you to access the Sun audio interface. The Sun
audio hardware is capable of recording and playing back audio data
in u-LAW<a id='l2h-5225' xml:id='l2h-5225'></a> format with a sample rate of 8K per second. A
full description can be found in the <span class="manpage"><i>audio</i>(7I)</span> manual page.

<P>
The module
<tt class="module"><a href="module-sunaudiodev-constants.html">SUNAUDIODEV</a></tt><a id='l2h-5226' xml:id='l2h-5226'></a> 
defines constants which may be used with this module.

<P>
This module defines the following variables and functions:

<P>
<dl><dt><b><span class="typelabel">exception</span>&nbsp;<tt id='l2h-5223' xml:id='l2h-5223' class="exception">error</tt></b></dt>
<dd>
This exception is raised on all errors. The argument is a string
describing what went wrong.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5224' xml:id='l2h-5224' class="function">open</tt></b>(</nobr></td>
  <td><var>mode</var>)</td></tr></table></dt>
<dd>
This function opens the audio device and returns a Sun audio device
object. This object can then be used to do I/O on. The <var>mode</var> parameter
is one of <code>'r'</code> for record-only access, <code>'w'</code> for play-only
access, <code>'rw'</code> for both and <code>'control'</code> for access to the
control device. Since only one process is allowed to have the recorder
or player open at the same time it is a good idea to open the device
only for the activity needed. See <span class="manpage"><i>audio</i>(7I)</span> for details.

<P>
As per the manpage, this module first looks in the environment
variable <code>AUDIODEV</code> for the base audio device filename.  If not
found, it falls back to <span class="file">/dev/audio</span>.  The control device is
calculated by appending ``ctl'' to the base audio device.
</dl>

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="audio-device-objects.html">21.1.1 Audio Device Objects</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="21. SunOS Specific Services"
  href="sunos.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="21. SunOS Specific Services"
  href="sunos.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="21.1.1 Audio Device Objects"
  href="audio-device-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="sunos.html">21. SunOS Specific Services</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="sunos.html">21. SunOS Specific Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="audio-device-objects.html">21.1.1 Audio Device Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
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-sunaudiodev-constants.html" />
	13	<link rel="prev" href="sunos.html" />
	14	<link rel="parent" href="sunos.html" />
	15	<link rel="next" href="audio-device-objects.html" />
	16	<meta name='aesop' content='information' />
	17	<title>21.1 sunaudiodev -- Access to Sun audio hardware</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="21. SunOS Specific Services"
	25	href="sunos.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="21. SunOS Specific Services"
	28	href="sunos.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="21.1.1 Audio Device Objects"
	31	href="audio-device-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="sunos.html">21. SunOS Specific Services</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="sunos.html">21. SunOS Specific Services</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="audio-device-objects.html">21.1.1 Audio Device Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION0023100000000000000000">
	56	21.1 <tt class="module">sunaudiodev</tt> --
	57	Access to Sun audio hardware</A>
	58	</H1>
	59
	60	<P>
	61	<A NAME="module-sunaudiodev"></A>
	62	<p class="availability">Availability: <span
	63	class="platform">SunOS</span>.</p>
	64
65	<P>
66	This module allows you to access the Sun audio interface. The Sun
67	audio hardware is capable of recording and playing back audio data
68	in u-LAW<a id='l2h-5225' xml:id='l2h-5225'></a> format with a sample rate of 8K per second. A
69	full description can be found in the <span class="manpage"><i>audio</i>(7I)</span> manual page.
70
71	<P>
72	The module
73	<tt class="module"><a href="module-sunaudiodev-constants.html">SUNAUDIODEV</a></tt><a id='l2h-5226' xml:id='l2h-5226'></a>
74	defines constants which may be used with this module.
75
76	<P>
77	This module defines the following variables and functions:
78
79	<P>
80	<dl><dt><b><span class="typelabel">exception</span> <tt id='l2h-5223' xml:id='l2h-5223' class="exception">error</tt></b></dt>
81	<dd>
82	This exception is raised on all errors. The argument is a string
83	describing what went wrong.
84	</dd></dl>
85
86	<P>
87	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
88	<td><nobr><b><tt id='l2h-5224' xml:id='l2h-5224' class="function">open</tt></b>(</nobr></td>
89	<td><var>mode</var>)</td></tr></table></dt>
90	<dd>
91	This function opens the audio device and returns a Sun audio device
92	object. This object can then be used to do I/O on. The <var>mode</var> parameter
93	is one of <code>'r'</code> for record-only access, <code>'w'</code> for play-only
94	access, <code>'rw'</code> for both and <code>'control'</code> for access to the
95	control device. Since only one process is allowed to have the recorder
96	or player open at the same time it is a good idea to open the device
97	only for the activity needed. See <span class="manpage"><i>audio</i>(7I)</span> for details.
98
99	<P>
100	As per the manpage, this module first looks in the environment
101	variable <code>AUDIODEV</code> for the base audio device filename. If not
102	found, it falls back to <span class="file">/dev/audio</span>. The control device is
103	calculated by appending ``ctl'' to the base audio device.
104	</dl>
105
106	<P>
107
108	<p><br /></p><hr class='online-navigation' />
109	<div class='online-navigation'>
110	<!--Table of Child-Links-->
111	<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>
112
113	<UL CLASS="ChildLinks">
114	<LI><A href="audio-device-objects.html">21.1.1 Audio Device Objects</a>
115	</ul>
116	<!--End of Table of Child-Links-->
117	</div>
118
119	<DIV CLASS="navigation">
120	<div class='online-navigation'>
121	<p></p><hr />
122	<table align="center" width="100%" cellpadding="0" cellspacing="2">
123	<tr>
124	<td class='online-navigation'><a rel="prev" title="21. SunOS Specific Services"
125	href="sunos.html"><img src='../icons/previous.png'
126	border='0' height='32' alt='Previous Page' width='32' /></A></td>
127	<td class='online-navigation'><a rel="parent" title="21. SunOS Specific Services"
128	href="sunos.html"><img src='../icons/up.png'
129	border='0' height='32' alt='Up One Level' width='32' /></A></td>
130	<td class='online-navigation'><a rel="next" title="21.1.1 Audio Device Objects"
131	href="audio-device-objects.html"><img src='../icons/next.png'
132	border='0' height='32' alt='Next Page' width='32' /></A></td>
133	<td align="center" width="100%">Python Library Reference</td>
134	<td class='online-navigation'><a rel="contents" title="Table of Contents"
135	href="contents.html"><img src='../icons/contents.png'
136	border='0' height='32' alt='Contents' width='32' /></A></td>
137	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
138	border='0' height='32' alt='Module Index' width='32' /></a></td>
139	<td class='online-navigation'><a rel="index" title="Index"
140	href="genindex.html"><img src='../icons/index.png'
141	border='0' height='32' alt='Index' width='32' /></A></td>
142	</tr></table>
143	<div class='online-navigation'>
144	<b class="navlabel">Previous:</b>
145	<a class="sectref" rel="prev" href="sunos.html">21. SunOS Specific Services</A>
146	<b class="navlabel">Up:</b>
147	<a class="sectref" rel="parent" href="sunos.html">21. SunOS Specific Services</A>
148	<b class="navlabel">Next:</b>
149	<a class="sectref" rel="next" href="audio-device-objects.html">21.1.1 Audio Device Objects</A>
150	</div>
151	</div>
152	<hr />
153	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
154	</DIV>
155	<!--End of Navigation Panel-->
156	<ADDRESS>
157	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
158	</ADDRESS>
159	</BODY>
160	</HTML>