Skip to content

Commit 5d02656

Browse files
committed
DOC: mention wait() in play()/rec()/playrec() docs
1 parent d622be9 commit 5d02656

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

sounddevice.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,8 @@ def play(data, samplerate=None, mapping=None, blocking=False, loop=False,
113113
* Start the stream.
114114
115115
* If ``blocking=True`` was given, wait until playback is done.
116-
If not, return immediately.
116+
If not, return immediately
117+
(to start waiting at a later point, `wait()` can be used).
117118
118119
If you need more control (e.g. block-wise gapless playback, multiple
119120
overlapping playbacks, ...), you should explicitly create an
@@ -195,7 +196,8 @@ def rec(frames=None, samplerate=None, channels=None, dtype=None,
195196
* Start the stream.
196197
197198
* If ``blocking=True`` was given, wait until recording is done.
198-
If not, return immediately.
199+
If not, return immediately
200+
(to start waiting at a later point, `wait()` can be used).
199201
200202
If you need more control (e.g. block-wise gapless recording,
201203
overlapping recordings, ...), you should explicitly create an
@@ -292,7 +294,8 @@ def playrec(data, samplerate=None, channels=None, dtype=None,
292294
* Start the stream.
293295
294296
* If ``blocking=True`` was given, wait until playback/recording is
295-
done. If not, return immediately.
297+
done. If not, return immediately
298+
(to start waiting at a later point, `wait()` can be used).
296299
297300
If you need more control (e.g. block-wise gapless playback and
298301
recording, realtime processing, ...),

0 commit comments

Comments
 (0)