Skip to content

Commit 91b7ba7

Browse files
committed
docs: An audiocore.Mixer suffices where another audio source would
1 parent a537208 commit 91b7ba7

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

shared-bindings/audiobusio/I2SOut.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiobusio_i2sout___exit___obj, 4, 4,
164164
//| Plays the sample once when loop=False and continuously when loop=True.
165165
//| Does not block. Use `playing` to block.
166166
//|
167-
//| Sample must be an `audioio.WaveFile` or `audioio.RawSample`.
167+
//| Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, or `audiocore.Mixer`.
168168
//|
169169
//| The sample itself should consist of 8 bit or 16 bit samples.
170170
//|

shared-bindings/audiocore/Mixer.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audioio_mixer___exit___obj, 4, 4, aud
152152
//| Plays the sample once when loop=False and continuously when loop=True.
153153
//| Does not block. Use `playing` to block.
154154
//|
155-
//| Sample must be an `audioio.WaveFile`, `audioio.Mixer` or `audioio.RawSample`.
155+
//| Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, or `audiocore.Mixer`.
156156
//|
157157
//| The sample must match the Mixer's encoding settings given in the constructor.
158158
//|

shared-bindings/audioio/AudioOut.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audioio_audioout___exit___obj, 4, 4,
163163
//| Plays the sample once when loop=False and continuously when loop=True.
164164
//| Does not block. Use `playing` to block.
165165
//|
166-
//| Sample must be an `audioio.WaveFile` or `audioio.RawSample`.
166+
//| Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, or `audiocore.Mixer`.
167167
//|
168168
//| The sample itself should consist of 16 bit samples. Microcontrollers with a lower output
169169
//| resolution will use the highest order bits to output. For example, the SAMD21 has a 10 bit

shared-bindings/audiopwmio/AudioOut.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(audiopwmio_audioout___exit___obj, 4,
166166
//| Plays the sample once when loop=False and continuously when loop=True.
167167
//| Does not block. Use `playing` to block.
168168
//|
169-
//| Sample must be an `audiopwmio.WaveFile` or `audiopwmio.RawSample`.
169+
//| Sample must be an `audiocore.WaveFile`, `audiocore.RawSample`, or `audiocore.Mixer`.
170170
//|
171171
//| The sample itself should consist of 16 bit samples. Microcontrollers with a lower output
172172
//| resolution will use the highest order bits to output. For example, the SAMD21 has a 10 bit

0 commit comments

Comments
 (0)