Skip to content

Commit 3b850e7

Browse files
GabrieleLSGabrieleAntoineMamou
authored
Update mixer documentation to clarify channel confusion (#3228)
Co-authored-by: Gabriele <gabriele.leblanc-spanu@imt-atlantique.net> Co-authored-by: AntoineM <160046187+AntoineMamou@users.noreply.github.com>
1 parent 816bd77 commit 3b850e7

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/reST/ref/mixer.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ The following file formats are supported
7979

8080
The channels argument is used to specify whether to use mono or stereo. 1
8181
for mono and 2 for stereo.
82+
``NOTE``: The channels argument is not related to the number
83+
of channels for playback of sounds, that you can get with the function
84+
"get_num_channels" or set with the function "set_num_channels" (see below).
8285

8386
The buffer argument controls the number of internal samples used in the
8487
sound mixer. The default value should work for most cases. It can be lowered
@@ -220,7 +223,7 @@ The following file formats are supported
220223
| :sl:`set the total number of playback channels`
221224
| :sg:`set_num_channels(count, /) -> None`
222225
223-
Sets the number of available channels for the mixer. The default value is 8.
226+
Sets the number of available playback channels for the mixer. The default value is 8.
224227
The value can be increased or decreased. If the value is decreased, sounds
225228
playing on the truncated channels are stopped.
226229

0 commit comments

Comments
 (0)