Play and Record Sound with Python

This Python module provides bindings for the PortAudio library and a few convenience functions to play and record NumPy arrays containing audio signals.

The sounddevice module is available for Linux, macOS and Windows.

Documentation:

https://python-sounddevice.readthedocs.io/

Source code repository and issue tracker:

https://github.com/spatialaudio/python-sounddevice/

License:

MIT – see the file LICENSE for details.

---

• Installation
• Usage
  • Playback
  • Recording
  • Simultaneous Playback and Recording
  • Device Selection
  • Callback Streams
  • Blocking Read/Write Streams
• Example Programs
  • Play a Sound File
  • Play a Very Long Sound File
  • Play a Very Long Sound File without Using NumPy
  • Play a Web Stream
  • Play a Sine Signal
  • Input to Output Pass-Through
  • Plot Microphone Signal(s) in Real-Time
  • Real-Time Text-Mode Spectrogram
  • Recording with Arbitrary Duration
  • Using a stream in an asyncio coroutine
  • Creating an asyncio generator for audio blocks
• Contributing
  • Reporting Problems
  • Development Installation
  • Building the Documentation
• API Documentation
  • Convenience Functions using NumPy Arrays
    • play()
    • rec()
    • playrec()
    • wait()
    • stop()
    • get_status()
    • get_stream()
  • Checking Available Hardware
    • query_devices()
    • DeviceList
    • query_hostapis()
    • check_input_settings()
    • check_output_settings()
  • Module-wide Default Settings
    • default
      • default.device
      • default.channels
      • default.dtype
      • default.latency
      • default.extra_settings
      • default.samplerate
      • default.blocksize
      • default.clip_off
      • default.dither_off
      • default.never_drop_input
      • default.prime_output_buffers_using_stream_callback
      • default.hostapi
      • default.reset()
  • Platform-specific Settings
    • AsioSettings
    • CoreAudioSettings
    • WasapiSettings
  • Streams using NumPy Arrays
    • Stream
      • Stream.abort()
      • Stream.active
      • Stream.blocksize
      • Stream.channels
      • Stream.close()
      • Stream.closed
      • Stream.cpu_load
      • Stream.device
      • Stream.dtype
      • Stream.latency
      • Stream.read()
      • Stream.read_available
      • Stream.samplerate
      • Stream.samplesize
      • Stream.start()
      • Stream.stop()
      • Stream.stopped
      • Stream.time
      • Stream.write()
      • Stream.write_available
    • InputStream
    • OutputStream
  • Raw Streams
    • RawStream
      • RawStream.read()
      • RawStream.write()
    • RawInputStream
    • RawOutputStream
  • Miscellaneous
    • sleep()
    • get_portaudio_version()
    • CallbackFlags
      • CallbackFlags.input_underflow
      • CallbackFlags.input_overflow
      • CallbackFlags.output_underflow
      • CallbackFlags.output_overflow
      • CallbackFlags.priming_output
    • CallbackStop
    • CallbackAbort
    • PortAudioError
      • PortAudioError.args
  • Expert Mode
    • _initialize()
    • _terminate()
    • _split()
    • _StreamBase
• Version History

Index