AudioSource Class Reference

Abstract Audio Data Source for the AudioPlayer which is used by the Audio Players. More...

#include <AudioSource.h>

Inheritance diagram for AudioSource:

Public Member Functions
virtual bool	begin ()=0
	Reset actual stream and move to root.
virtual int	index ()
	Returns the actual index of the stream.
virtual bool	isAutoNext ()
	Returns default setting go to the next.
virtual Stream *	nextStream (int offset)=0
	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)=0
	Returns audio stream by path: The index is not changed!
virtual Stream *	selectStream (int index)
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	setTimeout (int millisec)
	Sets the timeout of Stream in milliseconds.
virtual void	setTimeoutAutoNext (int millisec)
virtual int	timeoutAutoNext ()
	Provides the timeout which is triggering to move to the next stream.
virtual const char *	toStr ()
	provides the actual stream (e.g. file) name or url

Protected Attributes
int	timeout_auto_next_value = 500

Detailed Description

Abstract Audio Data Source for the AudioPlayer which is used by the Audio Players.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin()

virtual bool begin ( )

pure virtual

Reset actual stream and move to root.

Implemented in AudioSourceCallback, AudioSourceVector< FileType >, AudioSourceArray< FileType >, AudioSourceFTP< ClientType >, AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, and AudioSourceSDFAT< AudioFs, AudioFile >.

index()

virtual int index ( )

inlinevirtual

Returns the actual index of the stream.

Reimplemented in AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceVector< FileType >, AudioSourceArray< FileType >, and AudioSourceFTP< ClientType >.

isAutoNext()

virtual bool isAutoNext ( )

inlinevirtual

Returns default setting go to the next.

Reimplemented in AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, AudioSourceSDFAT< AudioFs, AudioFile >, and AudioSourceCallback.

nextStream()

virtual Stream * nextStream ( int  offset )

pure virtual

Returns next audio stream.

Implemented in AudioSourceCallback, AudioSourceVector< FileType >, AudioSourceArray< FileType >, AudioSourceFTP< ClientType >, AudioSourceURL, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, and AudioSourceVFS.

previousStream()

virtual Stream * previousStream ( int  offset )

inlinevirtual

Returns previous audio stream.

Reimplemented in AudioSourceFTP< ClientType >, and AudioSourceURL.

selectStream() [1/2]

virtual Stream * selectStream ( const char *  path )

pure virtual

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

Implemented in AudioSourceCallback, AudioSourceVector< FileType >, AudioSourceArray< FileType >, AudioSourceFTP< ClientType >, AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, and AudioSourceSDFAT< AudioFs, AudioFile >.

selectStream() [2/2]

virtual Stream * selectStream ( int  index )

inlinevirtual

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

Reimplemented in AudioSourceURL, AudioSourceCallback, AudioSourceVector< FileType >, AudioSourceArray< FileType >, AudioSourceFTP< ClientType >, AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceVFS, and AudioSourceSDFAT< AudioFs, AudioFile >.

setTimeout()

virtual void setTimeout ( int  millisec )

inlinevirtual

Sets the timeout of Stream in milliseconds.

Reimplemented in AudioSourceURL, and AudioSourceSDFAT< AudioFs, AudioFile >.

setTimeoutAutoNext()

virtual void setTimeoutAutoNext ( int  millisec )

inlinevirtual

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

toStr()

virtual const char * toStr ( )

inlinevirtual

provides the actual stream (e.g. file) name or url

Reimplemented in AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceVector< FileType >, AudioSourceArray< FileType >, and AudioSourceFTP< ClientType >.

---

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

• src/AudioTools/Disk/AudioSource.h