Skip to content

Commit f840ca0

Browse files
committed
DOC: Add some module documentation
1 parent 6e1d715 commit f840ca0

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

src/sounddevice.py

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,34 @@
1818
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
1919
# THE SOFTWARE.
2020

21-
"""Play and Record Sound with Python.
21+
"""Play and Record Sound with Python
2222
23-
http://python-sounddevice.readthedocs.io/
23+
API overview:
24+
* Convenience functions to play and record NumPy arrays:
25+
`play()`, `rec()`, `playrec()` and the related functions
26+
`wait()`, `stop()`, `get_status()`, `get_stream()`
27+
28+
* Module-wide default settings: `default`
29+
30+
* PortAudio streams, using NumPy arrays:
31+
`Stream`, `InputStream`, `OutputStream`
32+
33+
* PortAudio streams, using Python buffer objects (NumPy not needed):
34+
`RawStream`, `RawInputStream`, `RawOutputStream`
35+
36+
* Functions to get information about the available hardware:
37+
`query_devices()`, `query_hostapis()`,
38+
`check_input_settings()`, `check_output_settings()`
39+
40+
* Miscellaneous functions and classes:
41+
`sleep()`, `get_portaudio_version()`, `CallbackFlags`,
42+
`CallbackStop`, `CallbackAbort`
43+
44+
* Platform-specific settings:
45+
`AsioSettings`, `CoreAudioSettings`, `WasapiSettings`
46+
47+
Online documentation:
48+
http://python-sounddevice.readthedocs.io/
2449
2550
"""
2651
__version__ = '0.3.8'

0 commit comments

Comments
 (0)