arduino-audio-tools
|
Abstract Audio Data Source for the AudioPlayer which is used by the Audio Players. More...
#include <AudioSource.h>
Public Member Functions | |
virtual void | 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. | |
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 file name or url | |
Protected Attributes | |
int | timeout_auto_next_value = 500 |
Abstract Audio Data Source for the AudioPlayer which is used by the Audio Players.
|
pure virtual |
Reset actual stream and move to root.
Implemented in AudioSourceCallback, AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, and AudioSourceSDFAT.
|
inlinevirtual |
Returns the actual index of the stream.
Reimplemented in AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, and AudioSourceSDFAT.
|
inlinevirtual |
Returns default setting go to the next.
Reimplemented in AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, AudioSourceSDFAT, and AudioSourceCallback.
|
pure virtual |
Returns next audio stream.
Implemented in AudioSourceCallback, AudioSourceURL, AudioSourceSDFAT, AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, and AudioSourceVFS.
|
inlinevirtual |
Returns previous audio stream.
Reimplemented in AudioSourceURL.
|
pure virtual |
Returns audio stream by path.
Implemented in AudioSourceCallback, AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, and AudioSourceSDFAT.
|
inlinevirtual |
Returns audio stream at the indicated index (the index is zero based, so the first value is 0!)
Reimplemented in AudioSourceURL, AudioSourceCallback, AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceVFS, and AudioSourceSDFAT.
|
inlinevirtual |
Sets the timeout of Stream in milliseconds.
Reimplemented in AudioSourceURL, and AudioSourceSDFAT.
|
inlinevirtual |
Sets the timeout which is triggering to move to the next stream. - the default value is 500 ms
|
inlinevirtual |
provides the actual file name or url
Reimplemented in AudioSourceIdxSDFAT, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT, AudioSourceSDMMC, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVFS, and AudioSourceSDFAT.