AudioSourceSD Class Reference

ESP32 AudioSource for AudioPlayer using an SD card as data source. This class is based on the Arduino SD implementation Connect the SD card to the following pins: More...

#include <AudioSourceSD.h>

Inheritance diagram for AudioSourceSD:

Public Member Functions
	AudioSourceSD (const char *startFilePath="/", const char *ext=".mp3", int chipSelect=PIN_CS, bool setupIndex=true)
	Default constructor.
virtual void	begin () override
	Reset actual stream and move to root.
void	end ()
int	index ()
	Provides the current index position.
virtual bool	isAutoNext ()
	Returns default setting go to the next.
virtual Stream *	nextStream (int offset=1) override
	Returns next audio stream.
virtual Stream *	previousStream (int offset)
	Returns previous audio stream.
virtual Stream *	selectStream (const char *path) override
	Returns audio stream by path.
virtual Stream *	selectStream (int index) override
	Returns audio stream at the indicated index (the index is zero based, so the first value is 0!)
void	setFileFilter (const char *filter)
virtual Stream *	setIndex (int index)
	same as selectStream - I just prefer this name
virtual bool	setMetadataCallback (void(*fn)(MetaDataType info, const char *str, int len), ID3TypeSelection sel=SELECT_ICY)
virtual void	setPath (const char *p)
	Allows to "correct" the start path if not defined in the constructor.
virtual void	setTimeout (int millisec)
	Sets the timeout of Stream in milliseconds.
virtual void	setTimeoutAutoNext (int millisec)
	Sets the timeout which is triggering to move to the next stream. - the default value is 500 ms.
long	size ()
	Provides the number of files (The max index is size()-1): WARNING this is very slow if you have a lot of files in many subdirectories.
virtual int	timeoutAutoNext ()
	Provides the timeout which is triggering to move to the next stream.
const char *	toStr ()
	provides the actual file name

Protected Attributes
int	cs
const char *	exension = nullptr
File	file
const char *	file_name
const char *	file_name_pattern = "*"
SDDirect< fs::SDFS, fs::File >	idx {SD}
size_t	idx_pos = 0
bool	is_sd_setup = false
bool	setup_index = true
const char *	start_path = nullptr
int	timeout_auto_next_value = 500

Detailed Description

ESP32 AudioSource for AudioPlayer using an SD card as data source. This class is based on the Arduino SD implementation Connect the SD card to the following pins:

SD Card | ESP32 D2 - D3 SS CMD MOSI VSS GND VDD 3.3V CLK SCK VSS GND D0 MISO D1 -

On the AI Thinker boards the pin settings should be On, On, On, On, On,

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

setFileFilter()

void setFileFilter ( const char *  filter )

inline

Defines the regex filter criteria for selecting files. E.g. ".*Bob Dylan.*"

---

The documentation for this class was generated from the following file:

• src/AudioLibs/AudioSourceSD.h