arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
audio_tools::AudioSource Class Referenceabstract

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

#include <AudioSource.h>

Inheritance diagram for audio_tools::AudioSource:
audio_tools::AudioSourceCallback audio_tools::AudioSourceLittleFS audio_tools::AudioSourceSD audio_tools::AudioSourceSD audio_tools::AudioSourceSDFAT audio_tools::AudioSourceSDFAT audio_tools::AudioSourceSDFAT audio_tools::AudioSourceSDMMC audio_tools::AudioSourceSDMMC audio_tools::AudioSourceSPIFFS audio_tools::AudioSourceURL

Public Member Functions

virtual void begin ()=0
 Reset actual stream and move to root. More...
 
virtual bool isAutoNext ()
 Returns default setting go to the next. More...
 
virtual StreamnextStream (int offset)=0
 Returns next audio stream. More...
 
virtual StreampreviousStream (int offset)
 Returns previous audio stream. More...
 
virtual StreamselectStream (const char *path)=0
 Returns audio stream by path. More...
 
virtual StreamselectStream (int index)
 Returns audio stream at the indicated index (the index is zero based, so the first value is 0!) More...
 
virtual StreamsetIndex (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. More...
 
virtual void setTimeoutAutoNext (int millisec)
 Sets the timeout which is triggering to move to the next stream. - the default value is 500 ms.
 
virtual int timeoutAutoNext ()
 Provides the timeout which is triggering to move to the next stream.
 

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

Member Function Documentation

◆ begin()

virtual void audio_tools::AudioSource::begin ( )
pure virtual

◆ isAutoNext()

virtual bool audio_tools::AudioSource::isAutoNext ( )
inlinevirtual

◆ nextStream()

virtual Stream * audio_tools::AudioSource::nextStream ( int  offset)
pure virtual

◆ previousStream()

virtual Stream * audio_tools::AudioSource::previousStream ( int  offset)
inlinevirtual

Returns previous audio stream.

Reimplemented in audio_tools::AudioSourceURL.

◆ selectStream() [1/2]

virtual Stream * audio_tools::AudioSource::selectStream ( const char *  path)
pure virtual

◆ selectStream() [2/2]

virtual Stream * audio_tools::AudioSource::selectStream ( int  index)
inlinevirtual

◆ setTimeout()

virtual void audio_tools::AudioSource::setTimeout ( int  millisec)
inlinevirtual

Sets the timeout of Stream in milliseconds.

Reimplemented in audio_tools::AudioSourceURL, and audio_tools::AudioSourceSDFAT.


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