djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add note about memory usage for MP3Decoder

This commit is contained in:
Alec Delaney 2022-04-30 15:11:00 -06:00
parent 816a26e8b7
commit 3d145af587
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
shared-bindings/audiomp3/MP3Decoder.c
View File

@ -35,7 +35,14 @@
#include "supervisor/shared/translate.h" #include "supervisor/shared/translate.h"
//| class MP3Decoder: //| class MP3Decoder:
//| """Load a mp3 file for audio playback""" //| """Load a mp3 file for audio playback
//|
//| .. note::
//|
//| ``MP3Decoder`` uses a lot of contiguous memory, so care should be given to
//| optimizing memory usage. More information can be found here:
//| https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/reducing-memory-fragmentation
//| """
//| //|
//| def __init__(self, file: typing.BinaryIO, buffer: WriteableBuffer) -> None: //| def __init__(self, file: typing.BinaryIO, buffer: WriteableBuffer) -> None:
//| //|