Skip to content

Commit 8beb908

Browse files
authored
Merge pull request #6329 from tekktrik/personal/mp3decoder-docs
Add note about memory usage recommendation to MP3Decoder
2 parents b598ec0 + 92aeabf commit 8beb908

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

shared-bindings/audiomp3/MP3Decoder.c

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,14 @@
3535
#include "supervisor/shared/translate.h"
3636

3737
//| class MP3Decoder:
38-
//| """Load a mp3 file for audio playback"""
38+
//| """Load a mp3 file for audio playback
39+
//|
40+
//| .. note::
41+
//|
42+
//| ``MP3Decoder`` uses a lot of contiguous memory, so care should be given to
43+
//| optimizing memory usage. More information and recommendations can be found here:
44+
//| https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/reducing-memory-fragmentation
45+
//| """
3946
//|
4047
//| def __init__(self, file: typing.BinaryIO, buffer: WriteableBuffer) -> None:
4148
//|

0 commit comments

Comments
 (0)