Text of docs.python.org › 3.12 › library › ossaudiodev.html as Styx crawled it on Nov 20, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

ossaudiodev — Access to OSS-compatible audio devices — Python 3.12.16 documentation

Navigation index modules | next | previous | Python » 3.12.16 Documentation » The Python Standard Library » Superseded Modules » ossaudiodev — Access to OSS-compatible audio devices | Theme | ossaudiodev — Access to OSS-compatible audio devices ¶ Deprecated since version 3.11, will be removed in version 3.13: The ossaudiodev module is deprecated (see PEP 594 for details). 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. Changed in version 3.3: Operations in this module now raise OSError where IOError was raised. See also 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 <sys/soundcard.h> on either Linux or FreeBSD for a listing. ossaudiodev defines the following variables and functions: exception ossaudiodev.

OSSAudioError ¶ This exception is raised on certain errors. The argument is a string describing what went wrong. (If ossaudiodev receives an error from a system call such as open() , write() , or ioctl() , it raises OSError . Errors detected directly by ossaudiodev result in OSSAudioError .) (For backwards compatibility, the exception class is also available as ossaudiodev.error .) ossaudiodev. open ( mode ) ¶ ossaudiodev. open ( device , mode ) Open an audio device and return an OSS audio device object.

This object supports many file-like methods, such as read() , write() , and 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 AUDIODEV for a device to use.

If not found, it falls back to /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 linuxaudiodev module which ossaudiodev supersedes. ossaudiodev. 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 MIXERDEV for a device to use. If not found, it falls back to /dev/mixer . Audio Device Objects ¶ Before you can write to or read from an audio device, you must call three methods in the correct order: setfmt() to set the output format channels() to set the number of channels speed() to set the sample rate Alternately, you can use the 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 open() define the following methods and (read-only) attributes: 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. oss_audio_device. fileno ( ) ¶ Return the file descriptor associated with the device. 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 read() until the entire requested amount of data is available. oss_audio_device. write ( data ) ¶ Write a 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 writeall() . Changed in version 3.5: Writable bytes-like object is now accepted. oss_audio_device. writeall ( data ) ¶ Write a 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 write() ; 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. Changed in version 3.5: Writable bytes-like object is now accepted. Changed in version 3.2: Audio device objects also support the context management protocol, i.e. they can be used in a with statement. The following methods each map to exactly one ioctl() system call. The correspondence is obvious: for example, setfmt() corresponds to the SNDCTL_DSP_SETFMT ioctl, and sync() to SNDCTL_DSP_SYNC (this can be useful when consulting the OSS documentation).

If the underlying ioctl() fails, they all raise OSError . 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. 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 AFMT_MU_LAW a logarithmic encoding (used by Sun .au files and /dev/audio ) AFMT_A_LAW a logarithmic encoding AFMT_IMA_ADPCM a 4:1 compressed format defined by the Interactive Multimedia Association AFMT_U8 Unsigned, 8-bit audio AFMT_S16_LE Signed, 16-bit audio, little-endian byte order (as used by Intel processors) AFMT_S16_BE Signed, 16-bit audio, big-endian byte order (as used by 68k, PowerPC, Sparc) AFMT_S8 Signed, 8 bit audio AFMT_U16_LE Unsigned, 16-bit little-endian audio 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 AFMT_U8 ; the most common format used today is AFMT_S16_LE . oss_audio_device. setfmt ( format ) ¶ Try to set the current audio format to format —see 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 AFMT_QUERY . 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. 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 /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) 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 sync() . 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 reset() . oss_audio_device. post ( ) ¶ Tell the driver that there is likely to be a pause in

The rest of this page is on the live site.