AudioSourceSPIFFS Class Reference

ESP32 AudioSource for AudioPlayer using an the SPIFFS file system. More...

#include <AudioSourceSPIFFS.h>

Inheritance diagram for AudioSourceSPIFFS:

Public Member Functions
	AudioSourceSPIFFS (const char *startFilePath="/", const char *ext=".mp3")
	Default constructor.
virtual	~AudioSourceSPIFFS ()
virtual bool	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.
Stream *	operator[] (int idx)
	access with array syntax
virtual Stream *	previousStream (int offset)
	Returns previous audio stream.
virtual Stream *	selectStream (const char *path) override
	Returns audio stream by path: The index is not changed!
virtual Stream *	selectStream (int index) override
virtual void	setAutoNext (bool flag)
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)
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
const char *	exension = nullptr
File	file
const char *	file_name
const char *	file_name_pattern = "*"
SDDirect< fs::SPIFFSFS, fs::File >	idx {SPIFFS}
size_t	idx_pos = 0
bool	is_auto_next = true
bool	is_sd_setup = false
const char *	start_path = nullptr
int	timeout_auto_next_value = 500

Detailed Description

ESP32 AudioSource for AudioPlayer using an the SPIFFS file system.

Note

Supported only by Arduino platforms that support SPIFFS (e.g. ESP32)!

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioSourceSPIFFS()

AudioSourceSPIFFS ( const char *  startFilePath = "/", const char *  ext = ".mp3"  )

inline

Default constructor.

~AudioSourceSPIFFS()

virtual ~AudioSourceSPIFFS ( )

inlinevirtual

Member Function Documentation

begin()

virtual bool begin ( )

inlineoverridevirtual

Reset actual stream and move to root.

Implements AudioSource.

end()

void end ( )

inline

index()

int index ( )

inlinevirtual

Provides the current index position.

Reimplemented from AudioSource.

isAutoNext()

virtual bool isAutoNext ( )

inlinevirtual

Returns default setting go to the next.

Reimplemented from AudioSource.

nextStream()

virtual Stream * nextStream ( int  offset = 1 )

inlineoverridevirtual

Returns next audio stream.

Implements AudioSource.

operator[]()

Stream * operator[] ( int  idx )

inlineinherited

access with array syntax

previousStream()

virtual Stream * previousStream ( int  offset )

inlinevirtualinherited

Returns previous audio stream.

Reimplemented in AudioSourceFTP< ClientType >, and AudioSourceURL.

selectStream() [1/2]

virtual Stream * selectStream ( const char *  path )

inlineoverridevirtual

Returns audio stream by path: The index is not changed!

Implements AudioSource.

selectStream() [2/2]

virtual Stream * selectStream ( int  index )

inlineoverridevirtual

Returns audio stream at the indicated index (the index is zero based, so the first value is 0!)

Reimplemented from AudioSource.

setAutoNext()

virtual void setAutoNext ( bool  flag )

inlinevirtualinherited

Reimplemented in AudioSourceCallback.

setFileFilter()

void setFileFilter ( const char *  filter )

inline

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

setIndex()

virtual Stream * setIndex ( int  index )

inlinevirtualinherited

same as selectStream - I just prefer this name

setMetadataCallback()

virtual bool setMetadataCallback ( void(*)(MetaDataType info, const char *str, int len)  fn, ID3TypeSelection  sel = SELECT_ICY  )

inlinevirtualinherited

Reimplemented in AudioSourceURL.

setPath()

virtual void setPath ( const char *  p )

inlinevirtual

Allows to "correct" the start path if not defined in the constructor.

setTimeout()

virtual void setTimeout ( int  millisec )

inlinevirtualinherited

Sets the timeout of Stream in milliseconds.

Reimplemented in AudioSourceURL.

setTimeoutAutoNext()

virtual void setTimeoutAutoNext ( int  millisec )

inlinevirtualinherited

Sets the timeout which is triggering to move to the next stream. - the default value is 500 ms

size()

long size ( )

inline

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.

timeoutAutoNext()

virtual int timeoutAutoNext ( )

inlinevirtualinherited

Provides the timeout which is triggering to move to the next stream.

toStr()

const char * toStr ( )

inlinevirtual

provides the actual file name

Reimplemented from AudioSource.

Member Data Documentation

exension

const char* exension = nullptr

protected

file

File file

protected

file_name

const char* file_name

protected

file_name_pattern

const char* file_name_pattern = "*"

protected

idx

SDDirect<fs::SPIFFSFS,fs::File> idx {SPIFFS}

protected

idx_pos

size_t idx_pos = 0

protected

is_auto_next

bool is_auto_next = true

protectedinherited

is_sd_setup

bool is_sd_setup = false

protected

start_path

const char* start_path = nullptr

protected

timeout_auto_next_value

int timeout_auto_next_value = 500

protectedinherited

---

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

• src/AudioTools/Disk/AudioSourceSPIFFS.h