arduino-audio-tools
Public Member Functions | Protected Attributes | List of all members
AudioSource Class Referenceabstract

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

#include <AudioSource.h>

Inheritance diagram for AudioSource:
AudioSourceCallback AudioSourceIdxSD AudioSourceIdxSDFAT AudioSourceIdxSDMMC AudioSourceLittleFS AudioSourceSD AudioSourceSDFAT AudioSourceSDFAT AudioSourceSDMMC AudioSourceSPIFFS AudioSourceSTD AudioSourceURL

Public Member Functions

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

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