Skip to content

Commit 135f74d

Browse files
mgeierlarsoner
authored andcommitted
DOC: explain "channel" argument
1 parent 650cd90 commit 135f74d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,16 @@ Common parameters that are shared by most commands:
2323
The actual time will be stored in the ``actual_time`` field of the
2424
returned action.
2525

26+
``channels``
27+
This can be either the desired number of channels or a list of (1-based)
28+
channel numbers that is used as a channel map for playback/recording.
29+
2630
``allow_belated``
2731
Use ``False`` to cancel the command in case the requested time cannot be met.
2832
The ``actual_time`` field will be set to ``0.0`` in this case.
2933
Use ``True`` to execute the command nevertheless.
3034
Even if the requested time was met, the ``actual_time`` might be slightly
31-
different due to rounding.
35+
different due to rounding to the next audio sample.
3236

3337
All commands return a corresponding "action", which can be compared against the
3438
active `actions`, and can be used as input for `cancel()` and `wait()`.

0 commit comments

Comments
 (0)