arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AudioSourceDynamicURL Class Reference

Audio Source which provides the data via the network from an URL. The URLs are stored in an Vector of dynamically allocated strings. More...

#include <AudioSource.h>

Inheritance diagram for AudioSourceDynamicURL:
AudioSourceURL AudioSource

Public Member Functions

 AudioSourceDynamicURL (AbstractURLStream &urlStream, const char *mime, int startPos=0)
 
template<typename T , size_t N>
 AudioSourceDynamicURL (AbstractURLStream &urlStream, T(&urlArray)[N], const char *mime, int startPos=0)
 
void addURL (const char *url)
 add a new url: a copy of the string will be stored on the heap
 
virtual void begin () override
 Setup Wifi URL.
 
void clear ()
 
int index ()
 
virtual bool isAutoNext ()
 Returns default setting go to the next.
 
StreamnextStream (int offset) override
 Opens the next url from the array.
 
Streamoperator[] (int idx)
 access with array syntax
 
StreampreviousStream (int offset) override
 Opens the Previous url from the array.
 
StreamselectStream (const char *path) override
 Opens the selected url.
 
StreamselectStream (int idx) override
 Opens the selected url from the array.
 
virtual StreamsetIndex (int index)
 same as selectStream - I just prefer this name
 
bool setMetadataCallback (void(*fn)(MetaDataType info, const char *str, int len), ID3TypeSelection sel=SELECT_ICY)
 
void setTimeout (int millisec)
 Sets the timeout of the URL 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.
 
const chartoStr ()
 

Protected Member Functions

int size () override
 
const charvalue (int pos) override
 

Protected Attributes

AbstractURLStreamactual_stream = nullptr
 
int max = 0
 
const charmime = nullptr
 
int pos = 0
 
bool started = false
 
int timeout_auto_next_value = 500
 
Vector< Strurl_vector
 
const char ** urlArray = nullptr
 

Detailed Description

Audio Source which provides the data via the network from an URL. The URLs are stored in an Vector of dynamically allocated strings.

Author
Phil Schatzmann

Member Function Documentation

◆ begin()

virtual void begin ( )
inlineoverridevirtualinherited

Setup Wifi URL.

Implements AudioSource.

◆ isAutoNext()

virtual bool isAutoNext ( )
inlinevirtualinherited

Returns default setting go to the next.

Reimplemented from AudioSource.

◆ nextStream()

Stream * nextStream ( int  offset)
inlineoverridevirtualinherited

Opens the next url from the array.

Implements AudioSource.

◆ previousStream()

Stream * previousStream ( int  offset)
inlineoverridevirtualinherited

Opens the Previous url from the array.

Reimplemented from AudioSource.

◆ selectStream() [1/2]

Stream * selectStream ( const char path)
inlineoverridevirtualinherited

Opens the selected url.

Implements AudioSource.

◆ selectStream() [2/2]

Stream * selectStream ( int  idx)
inlineoverridevirtualinherited

Opens the selected url from the array.

Reimplemented from AudioSource.

◆ setMetadataCallback()

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

Reimplemented from AudioSource.

◆ setTimeout()

void setTimeout ( int  millisec)
inlinevirtualinherited

Sets the timeout of the URL Stream in milliseconds.

Reimplemented from AudioSource.

◆ size()

int size ( )
inlineoverrideprotectedvirtual

Reimplemented from AudioSourceURL.

◆ value()

const char * value ( int  pos)
inlineoverrideprotectedvirtual

Reimplemented from AudioSourceURL.


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