Merge pull request #6329 from tekktrik/personal/mp3decoder-docs

Add note about memory usage recommendation to MP3Decoder
This commit is contained in:
Limor "Ladyada" Fried 2022-04-30 21:13:20 -04:00 committed by GitHub
commit 8beb908d90
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions

View File

@ -35,7 +35,14 @@
#include "supervisor/shared/translate.h"
//| 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 and recommendations 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:
//|