Skip to content

Commit c8b72b9

Browse files
committed
DOC: State that play()/rec()/playrec() work on NumPy arrays
See #25.
1 parent 1886672 commit c8b72b9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

sounddevice.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@
255255

256256
def play(data, samplerate=None, mapping=None, blocking=False, loop=False,
257257
**kwargs):
258-
"""Play back an array of audio data.
258+
"""Play back a NumPy array containing audio data.
259259
260260
Parameters
261261
----------
@@ -308,7 +308,7 @@ def callback(outdata, frames, time, status):
308308

309309
def rec(frames=None, samplerate=None, channels=None, dtype=None,
310310
out=None, mapping=None, blocking=False, **kwargs):
311-
"""Record audio data.
311+
"""Record audio data into a NumPy array.
312312
313313
Parameters
314314
----------
@@ -380,7 +380,7 @@ def callback(indata, frames, time, status):
380380
def playrec(data, samplerate=None, channels=None, dtype=None,
381381
out=None, input_mapping=None, output_mapping=None, blocking=False,
382382
**kwargs):
383-
"""Simultaneous playback and recording.
383+
"""Simultaneous playback and recording of NumPy arrays.
384384
385385
Parameters
386386
----------

0 commit comments

Comments
 (0)