summaryrefslogtreecommitdiff
path: root/shared-bindings/audiocore/WaveFile.c
diff options
context:
space:
mode:
authorRadomir Dopieralski <openstack@sheep.art.pl>2019-08-17 11:31:45 +0200
committerRadomir Dopieralski <openstack@sheep.art.pl>2019-08-17 11:31:45 +0200
commit58b4cd49562dab4df42511cf86537bcf8209f2d9 (patch)
treeecc3ff91268429cc571fe5f9b064e72b3db10028 /shared-bindings/audiocore/WaveFile.c
parent9907e3fa288eb9c31d0152e56c4d9ba998cf8122 (diff)
Improve docs for WaveFile buffer
Diffstat (limited to 'shared-bindings/audiocore/WaveFile.c')
-rw-r--r--shared-bindings/audiocore/WaveFile.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/shared-bindings/audiocore/WaveFile.c b/shared-bindings/audiocore/WaveFile.c
index 7398353b0..01dc1e4c9 100644
--- a/shared-bindings/audiocore/WaveFile.c
+++ b/shared-bindings/audiocore/WaveFile.c
@@ -47,7 +47,8 @@
//| Load a .wav file for playback with `audioio.AudioOut` or `audiobusio.I2SOut`.
//|
//| :param typing.BinaryIO file: Already opened wave file
-//| :param bytearray buffer: Optional pre-allocated buffer
+//| :param bytearray buffer: Optional pre-allocated buffer, that will be split in half and used for double-buffering of the data. If not provided, two 512 byte buffers are allocated internally.
+//|
//|
//| Playing a wave file from flash::
//|