Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	editdlrm
abc.rst.txt	11805	0644	editdlrm
aifc.rst.txt	7503	0644	editdlrm
allos.rst.txt	678	0644	editdlrm
archiving.rst.txt	440	0644	editdlrm
argparse.rst.txt	77480	0644	editdlrm
array.rst.txt	10812	0644	editdlrm
ast.rst.txt	10159	0644	editdlrm
asynchat.rst.txt	8528	0644	editdlrm
asyncio-dev.rst.txt	13398	0644	editdlrm
asyncio-eventloop.rst.txt	33701	0644	editdlrm
asyncio-eventloops.rst.txt	7660	0644	editdlrm
asyncio-protocol.rst.txt	25170	0644	editdlrm
asyncio-queue.rst.txt	4328	0644	editdlrm
asyncio-stream.rst.txt	14363	0644	editdlrm
asyncio-subprocess.rst.txt	15544	0644	editdlrm
asyncio-sync.rst.txt	9078	0644	editdlrm
asyncio-task.rst.txt	25406	0644	editdlrm
asyncio.rst.txt	2272	0644	editdlrm
asyncore.rst.txt	13624	0644	editdlrm
atexit.rst.txt	3669	0644	editdlrm
audioop.rst.txt	10712	0644	editdlrm
base64.rst.txt	10371	0644	editdlrm
bdb.rst.txt	12985	0644	editdlrm
binary.rst.txt	654	0644	editdlrm
binascii.rst.txt	6539	0644	editdlrm
binhex.rst.txt	1709	0644	editdlrm
bisect.rst.txt	5398	0644	editdlrm
builtins.rst.txt	1465	0644	editdlrm
bz2.rst.txt	8825	0644	editdlrm
calendar.rst.txt	10988	0644	editdlrm
cgi.rst.txt	22650	0644	editdlrm
cgitb.rst.txt	2918	0644	editdlrm
chunk.rst.txt	5094	0644	editdlrm
cmath.rst.txt	9326	0644	editdlrm
cmd.rst.txt	13795	0644	editdlrm
code.rst.txt	7817	0644	editdlrm
codecs.rst.txt	75564	0644	editdlrm
codeop.rst.txt	3021	0644	editdlrm
collections.abc.rst.txt	12861	0644	editdlrm
collections.rst.txt	46063	0644	editdlrm
colorsys.rst.txt	1820	0644	editdlrm
compileall.rst.txt	8975	0644	editdlrm
concurrency.rst.txt	673	0644	editdlrm
concurrent.futures.rst.txt	16910	0644	editdlrm
concurrent.rst.txt	171	0644	editdlrm
configparser.rst.txt	48756	0644	editdlrm
constants.rst.txt	3331	0644	editdlrm
contextlib.rst.txt	28175	0644	editdlrm
copy.rst.txt	3378	0644	editdlrm
copyreg.rst.txt	2182	0644	editdlrm
crypt.rst.txt	5122	0644	editdlrm
crypto.rst.txt	411	0644	editdlrm
csv.rst.txt	19902	0644	editdlrm
ctypes.rst.txt	88613	0644	editdlrm
curses.ascii.rst.txt	8920	0644	editdlrm
curses.panel.rst.txt	2764	0644	editdlrm
curses.rst.txt	76397	0644	editdlrm
custominterp.rst.txt	569	0644	editdlrm
datatypes.rst.txt	751	0644	editdlrm
datetime.rst.txt	90524	0644	editdlrm
dbm.rst.txt	14293	0644	editdlrm
debug.rst.txt	471	0644	editdlrm
decimal.rst.txt	74869	0644	editdlrm
development.rst.txt	704	0644	editdlrm
difflib.rst.txt	29861	0644	editdlrm
dis.rst.txt	32567	0644	editdlrm
distribution.rst.txt	452	0644	editdlrm
distutils.rst.txt	1974	0644	editdlrm
doctest.rst.txt	71743	0644	editdlrm
dummy_threading.rst.txt	784	0644	editdlrm
email.charset.rst.txt	9293	0644	editdlrm
email.compat32-message.rst.txt	33493	0644	editdlrm
email.contentmanager.rst.txt	9112	0644	editdlrm
email.encoders.rst.txt	2715	0644	editdlrm
email.errors.rst.txt	4792	0644	editdlrm
email.examples.rst.txt	1915	0644	editdlrm
email.generator.rst.txt	13637	0644	editdlrm
email.header.rst.txt	9188	0644	editdlrm
email.headerregistry.rst.txt	17957	0644	editdlrm
email.iterators.rst.txt	2795	0644	editdlrm
email.message.rst.txt	33008	0644	editdlrm
email.mime.rst.txt	11721	0644	editdlrm
email.parser.rst.txt	14092	0644	editdlrm
email.policy.rst.txt	27022	0644	editdlrm
email.rst.txt	6785	0644	editdlrm
email.util.rst.txt	9214	0644	editdlrm
ensurepip.rst.txt	4987	0644	editdlrm
enum.rst.txt	32751	0644	editdlrm
errno.rst.txt	6811	0644	editdlrm
exceptions.rst.txt	25570	0644	editdlrm
faulthandler.rst.txt	6136	0644	editdlrm
fcntl.rst.txt	7152	0644	editdlrm
filecmp.rst.txt	5623	0644	editdlrm
fileformats.rst.txt	287	0644	editdlrm
fileinput.rst.txt	8051	0644	editdlrm
filesys.rst.txt	961	0644	editdlrm
fnmatch.rst.txt	3103	0644	editdlrm
formatter.rst.txt	13242	0644	editdlrm
fpectl.rst.txt	4180	0644	editdlrm
fractions.rst.txt	6364	0644	editdlrm
frameworks.rst.txt	391	0644	editdlrm
ftplib.rst.txt	17552	0644	editdlrm
functional.rst.txt	365	0644	editdlrm
functions.rst.txt	71621	0644	editdlrm
functools.rst.txt	18503	0644	editdlrm
gc.rst.txt	9694	0644	editdlrm
getopt.rst.txt	6557	0644	editdlrm
getpass.rst.txt	1882	0644	editdlrm
gettext.rst.txt	25588	0644	editdlrm
glob.rst.txt	3508	0644	editdlrm
grp.rst.txt	2417	0644	editdlrm
gzip.rst.txt	8301	0644	editdlrm
hashlib.rst.txt	26523	0644	editdlrm
heapq.rst.txt	13402	0644	editdlrm
hmac.rst.txt	4020	0644	editdlrm
html.entities.rst.txt	1319	0644	editdlrm
html.parser.rst.txt	11275	0644	editdlrm
html.rst.txt	1304	0644	editdlrm
http.client.rst.txt	18870	0644	editdlrm
http.cookiejar.rst.txt	27832	0644	editdlrm
http.cookies.rst.txt	8645	0644	editdlrm
http.rst.txt	7096	0644	editdlrm
http.server.rst.txt	17639	0644	editdlrm
i18n.rst.txt	408	0644	editdlrm
idle.rst.txt	25834	0644	editdlrm
imaplib.rst.txt	20367	0644	editdlrm
imghdr.rst.txt	2938	0644	editdlrm
imp.rst.txt	15548	0644	editdlrm
importlib.rst.txt	53563	0644	editdlrm
index.rst.txt	2258	0644	editdlrm
inspect.rst.txt	53928	0644	editdlrm
internet.rst.txt	992	0644	editdlrm
intro.rst.txt	2645	0644	editdlrm
io.rst.txt	40328	0644	editdlrm
ipaddress.rst.txt	32340	0644	editdlrm
ipc.rst.txt	649	0644	editdlrm
itertools.rst.txt	38459	0644	editdlrm
json.rst.txt	27876	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	522	0644	editdlrm
linecache.rst.txt	2408	0644	editdlrm
locale.rst.txt	25470	0644	editdlrm
logging.config.rst.txt	33886	0644	editdlrm
logging.handlers.rst.txt	42497	0644	editdlrm
logging.rst.txt	60479	0644	editdlrm
lzma.rst.txt	17361	0644	editdlrm
macpath.rst.txt	707	0644	editdlrm
mailbox.rst.txt	63055	0644	editdlrm
mailcap.rst.txt	3691	0644	editdlrm
markup.rst.txt	679	0644	editdlrm
marshal.rst.txt	4855	0644	editdlrm
math.rst.txt	14375	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
misc.rst.txt	247	0644	editdlrm
mm.rst.txt	431	0644	editdlrm
mmap.rst.txt	11232	0644	editdlrm
modulefinder.rst.txt	3240	0644	editdlrm
modules.rst.txt	355	0644	editdlrm
msilib.rst.txt	18612	0644	editdlrm
msvcrt.rst.txt	4392	0644	editdlrm
multiprocessing.rst.txt	104494	0644	editdlrm
netdata.rst.txt	339	0644	editdlrm
netrc.rst.txt	3007	0644	editdlrm
nis.rst.txt	1993	0644	editdlrm
nntplib.rst.txt	21821	0644	editdlrm
numbers.rst.txt	8089	0644	editdlrm
numeric.rst.txt	696	0644	editdlrm
operator.rst.txt	18989	0644	editdlrm
optparse.rst.txt	76996	0644	editdlrm
os.path.rst.txt	16419	0644	editdlrm
os.rst.txt	137534	0644	editdlrm
ossaudiodev.rst.txt	17845	0644	editdlrm
othergui.rst.txt	2822	0644	editdlrm
parser.rst.txt	15148	0644	editdlrm
pathlib.rst.txt	30045	0644	editdlrm
pdb.rst.txt	19454	0644	editdlrm
persistence.rst.txt	591	0644	editdlrm
pickle.rst.txt	37440	0644	editdlrm
pickletools.rst.txt	3729	0644	editdlrm
pipes.rst.txt	2557	0644	editdlrm
pkgutil.rst.txt	8730	0644	editdlrm
platform.rst.txt	9624	0644	editdlrm
plistlib.rst.txt	7398	0644	editdlrm
poplib.rst.txt	8197	0644	editdlrm
posix.rst.txt	3694	0644	editdlrm
pprint.rst.txt	14274	0644	editdlrm
profile.rst.txt	27969	0644	editdlrm
pty.rst.txt	3123	0644	editdlrm
pwd.rst.txt	2739	0644	editdlrm
pyclbr.rst.txt	3297	0644	editdlrm
pydoc.rst.txt	4688	0644	editdlrm
pyexpat.rst.txt	28620	0644	editdlrm
python.rst.txt	475	0644	editdlrm
py_compile.rst.txt	3851	0644	editdlrm
queue.rst.txt	7268	0644	editdlrm
quopri.rst.txt	2571	0644	editdlrm
random.rst.txt	18503	0644	editdlrm
re.rst.txt	64936	0644	editdlrm
readline.rst.txt	11943	0644	editdlrm
reprlib.rst.txt	5162	0644	editdlrm
resource.rst.txt	12291	0644	editdlrm
rlcompleter.rst.txt	2294	0644	editdlrm
runpy.rst.txt	8285	0644	editdlrm
sched.rst.txt	4842	0644	editdlrm
secrets.rst.txt	5930	0644	editdlrm
select.rst.txt	28175	0644	editdlrm
selectors.rst.txt	8925	0644	editdlrm
shelve.rst.txt	8390	0644	editdlrm
shlex.rst.txt	16441	0644	editdlrm
shutil.rst.txt	26014	0644	editdlrm
signal.rst.txt	17218	0644	editdlrm
site.rst.txt	9628	0644	editdlrm
smtpd.rst.txt	10806	0644	editdlrm
smtplib.rst.txt	23439	0644	editdlrm
sndhdr.rst.txt	1994	0644	editdlrm
socket.rst.txt	68202	0644	editdlrm
socketserver.rst.txt	23712	0644	editdlrm
spwd.rst.txt	2958	0644	editdlrm
sqlite3.rst.txt	39215	0644	editdlrm
ssl.rst.txt	96021	0644	editdlrm
stat.rst.txt	9805	0644	editdlrm
statistics.rst.txt	15301	0644	editdlrm
stdtypes.rst.txt	179240	0644	editdlrm
string.rst.txt	35374	0644	editdlrm
stringprep.rst.txt	4279	0644	editdlrm
struct.rst.txt	19581	0644	editdlrm
subprocess.rst.txt	45793	0644	editdlrm
sunau.rst.txt	7390	0644	editdlrm
superseded.rst.txt	258	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	4964	0644	editdlrm
sys.rst.txt	58273	0644	editdlrm
sysconfig.rst.txt	8749	0644	editdlrm
syslog.rst.txt	4302	0644	editdlrm
tabnanny.rst.txt	2007	0644	editdlrm
tarfile.rst.txt	31749	0644	editdlrm
telnetlib.rst.txt	7899	0644	editdlrm
tempfile.rst.txt	13857	0644	editdlrm
termios.rst.txt	3751	0644	editdlrm
test.rst.txt	25764	0644	editdlrm
text.rst.txt	584	0644	editdlrm
textwrap.rst.txt	10519	0644	editdlrm
threading.rst.txt	39257	0644	editdlrm
time.rst.txt	32967	0644	editdlrm
timeit.rst.txt	13000	0644	editdlrm
tk.rst.txt	1639	0644	editdlrm
tkinter.rst.txt	33027	0644	editdlrm
tkinter.scrolledtext.rst.txt	1255	0644	editdlrm
tkinter.tix.rst.txt	22653	0644	editdlrm
tkinter.ttk.rst.txt	58489	0644	editdlrm
token.rst.txt	2607	0644	editdlrm
tokenize.rst.txt	10002	0644	editdlrm
trace.rst.txt	6914	0644	editdlrm
traceback.rst.txt	17854	0644	editdlrm
tracemalloc.rst.txt	22089	0644	editdlrm
tty.rst.txt	1097	0644	editdlrm
turtle.rst.txt	71221	0644	editdlrm
types.rst.txt	9999	0644	editdlrm
typing.rst.txt	34332	0644	editdlrm
undoc.rst.txt	780	0644	editdlrm
unicodedata.rst.txt	5762	0644	editdlrm
unittest.mock-examples.rst.txt	46206	0644	editdlrm
unittest.mock.rst.txt	85991	0644	editdlrm
unittest.rst.txt	93304	0644	editdlrm
unix.rst.txt	446	0644	editdlrm
urllib.error.rst.txt	2199	0644	editdlrm
urllib.parse.rst.txt	27332	0644	editdlrm
urllib.request.rst.txt	59360	0644	editdlrm
urllib.robotparser.rst.txt	2969	0644	editdlrm
urllib.rst.txt	466	0644	editdlrm
uu.rst.txt	2387	0644	editdlrm
uuid.rst.txt	8760	0644	editdlrm
venv.rst.txt	20621	0644	editdlrm
warnings.rst.txt	20152	0644	editdlrm
wave.rst.txt	6870	0644	editdlrm
weakref.rst.txt	21328	0644	editdlrm
webbrowser.rst.txt	9783	0644	editdlrm
windows.rst.txt	272	0644	editdlrm
winreg.rst.txt	24073	0644	editdlrm
winsound.rst.txt	5134	0644	editdlrm
wsgiref.rst.txt	33047	0644	editdlrm
xdrlib.rst.txt	8078	0644	editdlrm
xml.dom.minidom.rst.txt	10198	0644	editdlrm
xml.dom.pulldom.rst.txt	5186	0644	editdlrm
xml.dom.rst.txt	39507	0644	editdlrm
xml.etree.elementtree.rst.txt	43871	0644	editdlrm
xml.rst.txt	6071	0644	editdlrm
xml.sax.handler.rst.txt	15399	0644	editdlrm
xml.sax.reader.rst.txt	12133	0644	editdlrm
xml.sax.rst.txt	7159	0644	editdlrm
xml.sax.utils.rst.txt	3901	0644	editdlrm
xmlrpc.client.rst.txt	23071	0644	editdlrm
xmlrpc.rst.txt	475	0644	editdlrm
xmlrpc.server.rst.txt	14990	0644	editdlrm
zipapp.rst.txt	17392	0644	editdlrm
zipfile.rst.txt	24005	0644	editdlrm
zipimport.rst.txt	5805	0644	editdlrm
zlib.rst.txt	13912	0644	editdlrm
_dummy_thread.rst.txt	762	0644	editdlrm
_thread.rst.txt	6886	0644	editdlrm
__future__.rst.txt	5245	0644	editdlrm
__main__.rst.txt	904	0644	editdlrm

:mod:`ossaudiodev` --- Access to OSS-compatible audio devices ============================================================= .. module:: ossaudiodev :platform: Linux, FreeBSD :synopsis: Access to OSS-compatible audio devices. -------------- This module allows you to access the OSS (Open Sound System) audio interface. OSS is available for a wide range of open-source and commercial Unices, and is the standard audio interface for Linux and recent versions of FreeBSD. .. Things will get more complicated for future Linux versions, since ALSA is in the standard kernel as of 2.5.x. Presumably if you use ALSA, you'll have to make sure its OSS compatibility layer is active to use ossaudiodev, but you're going to need it for the vast majority of Linux audio apps anyway. Sounds like things are also complicated for other BSDs. In response to my python-dev query, Thomas Wouters said: > Likewise, googling shows OpenBSD also uses OSS/Free -- the commercial > OSS installation manual tells you to remove references to OSS/Free from the > kernel :) but Aleksander Piotrowsk actually has an OpenBSD box, and he quotes from its : > * WARNING! WARNING! > * This is an OSS (Linux) audio emulator. > * Use the Native NetBSD API for developing new code, and this > * only for compiling Linux programs. There's also an ossaudio manpage on OpenBSD that explains things further. Presumably NetBSD and OpenBSD have a different standard audio interface. That's the great thing about standards, there are so many to choose from ... ;-) This probably all warrants a footnote or two, but I don't understand things well enough right now to write it! --GPW .. versionchanged:: 3.3 Operations in this module now raise :exc:`OSError` where :exc:`IOError` was raised. .. seealso:: `Open Sound System Programmer's Guide `_ the official documentation for the OSS C API The module defines a large number of constants supplied by the OSS device driver; see ```` on either Linux or FreeBSD for a listing. :mod:`ossaudiodev` defines the following variables and functions: .. exception:: OSSAudioError This exception is raised on certain errors. The argument is a string describing what went wrong. (If :mod:`ossaudiodev` receives an error from a system call such as :c:func:`open`, :c:func:`write`, or :c:func:`ioctl`, it raises :exc:`OSError`. Errors detected directly by :mod:`ossaudiodev` result in :exc:`OSSAudioError`.) (For backwards compatibility, the exception class is also available as ``ossaudiodev.error``.) .. function:: open(mode) open(device, mode) Open an audio device and return an OSS audio device object. This object supports many file-like methods, such as :meth:`read`, :meth:`write`, and :meth:`fileno` (although there are subtle differences between conventional Unix read/write semantics and those of OSS audio devices). It also supports a number of audio-specific methods; see below for the complete list of methods. *device* is the audio device filename to use. If it is not specified, this module first looks in the environment variable :envvar:`AUDIODEV` for a device to use. If not found, it falls back to :file:`/dev/dsp`. *mode* is one of ``'r'`` for read-only (record) access, ``'w'`` for write-only (playback) access and ``'rw'`` for both. Since many sound cards only allow one process to have the recorder or player open at a time, it is a good idea to open the device only for the activity needed. Further, some sound cards are half-duplex: they can be opened for reading or writing, but not both at once. Note the unusual calling syntax: the *first* argument is optional, and the second is required. This is a historical artifact for compatibility with the older :mod:`linuxaudiodev` module which :mod:`ossaudiodev` supersedes. .. XXX it might also be motivated by my unfounded-but-still-possibly-true belief that the default audio device varies unpredictably across operating systems. -GW .. function:: openmixer([device]) Open a mixer device and return an OSS mixer device object. *device* is the mixer device filename to use. If it is not specified, this module first looks in the environment variable :envvar:`MIXERDEV` for a device to use. If not found, it falls back to :file:`/dev/mixer`. .. _ossaudio-device-objects: Audio Device Objects -------------------- Before you can write to or read from an audio device, you must call three methods in the correct order: #. :meth:`setfmt` to set the output format #. :meth:`channels` to set the number of channels #. :meth:`speed` to set the sample rate Alternately, you can use the :meth:`setparameters` method to set all three audio parameters at once. This is more convenient, but may not be as flexible in all cases. The audio device objects returned by :func:`.open` define the following methods and (read-only) attributes: .. method:: oss_audio_device.close() Explicitly close the audio device. When you are done writing to or reading from an audio device, you should explicitly close it. A closed device cannot be used again. .. method:: oss_audio_device.fileno() Return the file descriptor associated with the device. .. method:: oss_audio_device.read(size) Read *size* bytes from the audio input and return them as a Python string. Unlike most Unix device drivers, OSS audio devices in blocking mode (the default) will block :func:`read` until the entire requested amount of data is available. .. method:: oss_audio_device.write(data) Write a :term:`bytes-like object` *data* to the audio device and return the number of bytes written. If the audio device is in blocking mode (the default), the entire data is always written (again, this is different from usual Unix device semantics). If the device is in non-blocking mode, some data may not be written ---see :meth:`writeall`. .. versionchanged:: 3.5 Writable :term:`bytes-like object` is now accepted. .. method:: oss_audio_device.writeall(data) Write a :term:`bytes-like object` *data* to the audio device: waits until the audio device is able to accept data, writes as much data as it will accept, and repeats until *data* has been completely written. If the device is in blocking mode (the default), this has the same effect as :meth:`write`; :meth:`writeall` is only useful in non-blocking mode. Has no return value, since the amount of data written is always equal to the amount of data supplied. .. versionchanged:: 3.5 Writable :term:`bytes-like object` is now accepted. .. versionchanged:: 3.2 Audio device objects also support the context management protocol, i.e. they can be used in a :keyword:`with` statement. The following methods each map to exactly one :c:func:`ioctl` system call. The correspondence is obvious: for example, :meth:`setfmt` corresponds to the ``SNDCTL_DSP_SETFMT`` ioctl, and :meth:`sync` to ``SNDCTL_DSP_SYNC`` (this can be useful when consulting the OSS documentation). If the underlying :c:func:`ioctl` fails, they all raise :exc:`OSError`. .. method:: oss_audio_device.nonblock() Put the device into non-blocking mode. Once in non-blocking mode, there is no way to return it to blocking mode. .. method:: oss_audio_device.getfmts() Return a bitmask of the audio output formats supported by the soundcard. Some of the formats supported by OSS are: +-------------------------+---------------------------------------------+ | Format | Description | +=========================+=============================================+ | :const:`AFMT_MU_LAW` | a logarithmic encoding (used by Sun ``.au`` | | | files and :file:`/dev/audio`) | +-------------------------+---------------------------------------------+ | :const:`AFMT_A_LAW` | a logarithmic encoding | +-------------------------+---------------------------------------------+ | :const:`AFMT_IMA_ADPCM` | a 4:1 compressed format defined by the | | | Interactive Multimedia Association | +-------------------------+---------------------------------------------+ | :const:`AFMT_U8` | Unsigned, 8-bit audio | +-------------------------+---------------------------------------------+ | :const:`AFMT_S16_LE` | Signed, 16-bit audio, little-endian byte | | | order (as used by Intel processors) | +-------------------------+---------------------------------------------+ | :const:`AFMT_S16_BE` | Signed, 16-bit audio, big-endian byte order | | | (as used by 68k, PowerPC, Sparc) | +-------------------------+---------------------------------------------+ | :const:`AFMT_S8` | Signed, 8 bit audio | +-------------------------+---------------------------------------------+ | :const:`AFMT_U16_LE` | Unsigned, 16-bit little-endian audio | +-------------------------+---------------------------------------------+ | :const:`AFMT_U16_BE` | Unsigned, 16-bit big-endian audio | +-------------------------+---------------------------------------------+ Consult the OSS documentation for a full list of audio formats, and note that most devices support only a subset of these formats. Some older devices only support :const:`AFMT_U8`; the most common format used today is :const:`AFMT_S16_LE`. .. method:: oss_audio_device.setfmt(format) Try to set the current audio format to *format*---see :meth:`getfmts` for a list. Returns the audio format that the device was set to, which may not be the requested format. May also be used to return the current audio format---do this by passing an "audio format" of :const:`AFMT_QUERY`. .. method:: oss_audio_device.channels(nchannels) Set the number of output channels to *nchannels*. A value of 1 indicates monophonic sound, 2 stereophonic. Some devices may have more than 2 channels, and some high-end devices may not support mono. Returns the number of channels the device was set to. .. method:: oss_audio_device.speed(samplerate) Try to set the audio sampling rate to *samplerate* samples per second. Returns the rate actually set. Most sound devices don't support arbitrary sampling rates. Common rates are: +-------+-------------------------------------------+ | Rate | Description | +=======+===========================================+ | 8000 | default rate for :file:`/dev/audio` | +-------+-------------------------------------------+ | 11025 | speech recording | +-------+-------------------------------------------+ | 22050 | | +-------+-------------------------------------------+ | 44100 | CD quality audio (at 16 bits/sample and 2 | | | channels) | +-------+-------------------------------------------+ | 96000 | DVD quality audio (at 24 bits/sample) | +-------+-------------------------------------------+ .. method:: oss_audio_device.sync() Wait until the sound device has played every byte in its buffer. (This happens implicitly when the device is closed.) The OSS documentation recommends closing and re-opening the device rather than using :meth:`sync`. .. method:: oss_audio_device.reset() Immediately stop playing or recording and return the device to a state where it can accept commands. The OSS documentation recommends closing and re-opening the device after calling :meth:`reset`. .. method:: oss_audio_device.post() Tell the driver that there is likely to be a pause in the output, making it possible for the device to handle the pause more intelligently. You might use this after playing a spot sound effect, before waiting for user input, or before doing disk I/O. The following convenience methods combine several ioctls, or one ioctl and some simple calculations. .. method:: oss_audio_device.setparameters(format, nchannels, samplerate[, strict=False]) Set the key audio sampling parameters---sample format, number of channels, and sampling rate---in one method call. *format*, *nchannels*, and *samplerate* should be as specified in the :meth:`setfmt`, :meth:`channels`, and :meth:`speed` methods. If *strict* is true, :meth:`setparameters` checks to see if each parameter was actually set to the requested value, and raises :exc:`OSSAudioError` if not. Returns a tuple (*format*, *nchannels*, *samplerate*) indicating the parameter values that were actually set by the device driver (i.e., the same as the return values of :meth:`setfmt`, :meth:`channels`, and :meth:`speed`). For example, :: (fmt, channels, rate) = dsp.setparameters(fmt, channels, rate) is equivalent to :: fmt = dsp.setfmt(fmt) channels = dsp.channels(channels) rate = dsp.rate(rate) .. method:: oss_audio_device.bufsize() Returns the size of the hardware buffer, in samples. .. method:: oss_audio_device.obufcount() Returns the number of samples that are in the hardware buffer yet to be played. .. method:: oss_audio_device.obuffree() Returns the number of samples that could be queued into the hardware buffer to be played without blocking. Audio device objects also support several read-only attributes: .. attribute:: oss_audio_device.closed Boolean indicating whether the device has been closed. .. attribute:: oss_audio_device.name String containing the name of the device file. .. attribute:: oss_audio_device.mode The I/O mode for the file, either ``"r"``, ``"rw"``, or ``"w"``. .. _mixer-device-objects: Mixer Device Objects -------------------- The mixer object provides two file-like methods: .. method:: oss_mixer_device.close() This method closes the open mixer device file. Any further attempts to use the mixer after this file is closed will raise an :exc:`OSError`. .. method:: oss_mixer_device.fileno() Returns the file handle number of the open mixer device file. .. versionchanged:: 3.2 Mixer objects also support the context management protocol. The remaining methods are specific to audio mixing: .. method:: oss_mixer_device.controls() This method returns a bitmask specifying the available mixer controls ("Control" being a specific mixable "channel", such as :const:`SOUND_MIXER_PCM` or :const:`SOUND_MIXER_SYNTH`). This bitmask indicates a subset of all available mixer controls---the :const:`SOUND_MIXER_\*` constants defined at module level. To determine if, for example, the current mixer object supports a PCM mixer, use the following Python code:: mixer=ossaudiodev.openmixer() if mixer.controls() & (1 << ossaudiodev.SOUND_MIXER_PCM): # PCM is supported ... code ... For most purposes, the :const:`SOUND_MIXER_VOLUME` (master volume) and :const:`SOUND_MIXER_PCM` controls should suffice---but code that uses the mixer should be flexible when it comes to choosing mixer controls. On the Gravis Ultrasound, for example, :const:`SOUND_MIXER_VOLUME` does not exist. .. method:: oss_mixer_device.stereocontrols() Returns a bitmask indicating stereo mixer controls. If a bit is set, the corresponding control is stereo; if it is unset, the control is either monophonic or not supported by the mixer (use in combination with :meth:`controls` to determine which). See the code example for the :meth:`controls` function for an example of getting data from a bitmask. .. method:: oss_mixer_device.reccontrols() Returns a bitmask specifying the mixer controls that may be used to record. See the code example for :meth:`controls` for an example of reading from a bitmask. .. method:: oss_mixer_device.get(control) Returns the volume of a given mixer control. The returned volume is a 2-tuple ``(left_volume,right_volume)``. Volumes are specified as numbers from 0 (silent) to 100 (full volume). If the control is monophonic, a 2-tuple is still returned, but both volumes are the same. Raises :exc:`OSSAudioError` if an invalid control is specified, or :exc:`OSError` if an unsupported control is specified. .. method:: oss_mixer_device.set(control, (left, right)) Sets the volume for a given mixer control to ``(left,right)``. ``left`` and ``right`` must be ints and between 0 (silent) and 100 (full volume). On success, the new volume is returned as a 2-tuple. Note that this may not be exactly the same as the volume specified, because of the limited resolution of some soundcard's mixers. Raises :exc:`OSSAudioError` if an invalid mixer control was specified, or if the specified volumes were out-of-range. .. method:: oss_mixer_device.get_recsrc() This method returns a bitmask indicating which control(s) are currently being used as a recording source. .. method:: oss_mixer_device.set_recsrc(bitmask) Call this function to specify a recording source. Returns a bitmask indicating the new recording source (or sources) if successful; raises :exc:`OSError` if an invalid source was specified. To set the current recording source to the microphone input:: mixer.setrecsrc (1 << ossaudiodev.SOUND_MIXER_MIC)