API Documentation

Play and Record Sound with Python.

API overview:

• Convenience functions to play and record NumPy arrays: play(), rec(), playrec() and the related functions wait(), stop(), get_status(), get_stream()
• Functions to get information about the available hardware: query_devices(), query_hostapis(), check_input_settings(), check_output_settings()
• Module-wide default settings: default
• Platform-specific settings: AsioSettings, CoreAudioSettings, WasapiSettings
• PortAudio streams, using NumPy arrays: Stream, InputStream, OutputStream
• PortAudio streams, using Python buffer objects (NumPy not needed): RawStream, RawInputStream, RawOutputStream
• Miscellaneous functions and classes: sleep(), get_portaudio_version(), CallbackFlags, CallbackStop, CallbackAbort

Online documentation:

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

---

• Convenience Functions using NumPy Arrays
• Checking Available Hardware
• Module-wide Default Settings
• Platform-specific Settings
• Streams using NumPy Arrays
• Raw Streams
• Miscellaneous