AudioSourceURL Class Reference

Audio Source which provides the data via the network from an URL. More...

#include <AudioSourceURL.h>

Inheritance diagram for AudioSourceURL:

Public Member Functions
template<typename T , size_t N>
	AudioSourceURL (AbstractURLStream &urlStream, T(&urlArray)[N], const char *mime, int startPos=0)
virtual	~AudioSourceURL ()
virtual bool	begin () override
	Setup Wifi URL.
void	end ()
int	index ()
	Returns the actual index of the stream.
virtual bool	isAutoNext ()
	Returns default setting go to the next.
Stream *	nextStream (int offset) override
	Opens the next url from the array.
Stream *	operator[] (int idx)
	access with array syntax
Stream *	previousStream (int offset) override
	Opens the Previous url from the array.
Stream *	selectStream (const char *path) override
	Opens the selected url.
Stream *	selectStream (int idx) override
	Opens the selected url from the array.
virtual void	setAutoNext (bool flag)
virtual Stream *	setIndex (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)
virtual int	size ()
virtual int	timeoutAutoNext ()
	Provides the timeout which is triggering to move to the next stream.
const char *	toStr ()
	provides the actual stream (e.g. file) name or url

Protected Member Functions
	AudioSourceURL ()=default
	allow use with empty constructor in subclasses
virtual const char *	value (int pos)

Protected Attributes
AbstractURLStream *	actual_stream = nullptr
bool	is_auto_next = true
int	max = 0
const char *	mime = nullptr
int	pos = 0
bool	started = false
int	timeout_auto_next_value = 500
const char **	urlArray = nullptr

Detailed Description

Audio Source which provides the data via the network from an URL.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioSourceURL() [1/2]

template<typename T , size_t N>

AudioSourceURL ( AbstractURLStream &  urlStream, T(&)  urlArray[N], const char *  mime, int  startPos = 0  )

inline

~AudioSourceURL()

virtual ~AudioSourceURL ( )

inlinevirtual

AudioSourceURL() [2/2]

AudioSourceURL ( )

protecteddefault

allow use with empty constructor in subclasses

Member Function Documentation

begin()

virtual bool begin ( )

inlineoverridevirtual

Setup Wifi URL.

Implements AudioSource.

end()

void end ( )

inline

index()

int index ( )

inlinevirtual

Returns the actual index of the stream.

Reimplemented from AudioSource.

isAutoNext()

virtual bool isAutoNext ( )

inlinevirtual

Returns default setting go to the next.

Reimplemented from AudioSource.

nextStream()

Stream * nextStream ( int  offset )

inlineoverridevirtual

Opens the next url from the array.

Implements AudioSource.

operator[]()

Stream * operator[] ( int  idx )

inlineinherited

access with array syntax

previousStream()

Stream * previousStream ( int  offset )

inlineoverridevirtual

Opens the Previous url from the array.

Reimplemented from AudioSource.

selectStream() [1/2]

Stream * selectStream ( const char *  path )

inlineoverridevirtual

Opens the selected url.

Implements AudioSource.

selectStream() [2/2]

Stream * selectStream ( int  idx )

inlineoverridevirtual

Opens the selected url from the array.

Reimplemented from AudioSource.

setAutoNext()

virtual void setAutoNext ( bool  flag )

inlinevirtualinherited

Reimplemented in AudioSourceCallback.

setIndex()

virtual Stream * setIndex ( int  index )

inlinevirtualinherited

same as selectStream - I just prefer this name

setMetadataCallback()

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

inlinevirtual

Reimplemented from AudioSource.

setTimeout()

void setTimeout ( int  millisec )

inlinevirtual

Sets the timeout of the URL Stream in milliseconds.

Reimplemented from AudioSource.

setTimeoutAutoNext()

virtual void setTimeoutAutoNext ( int  millisec )

inlinevirtualinherited

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

size()

virtual int size ( )

inlinevirtual

Reimplemented in AudioSourceDynamicURL.

timeoutAutoNext()

virtual int timeoutAutoNext ( )

inlinevirtualinherited

Provides the timeout which is triggering to move to the next stream.

toStr()

const char * toStr ( )

inlinevirtual

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

Reimplemented from AudioSource.

value()

virtual const char * value ( int  pos )

inlineprotectedvirtual

Reimplemented in AudioSourceDynamicURL.

Member Data Documentation

actual_stream

AbstractURLStream* actual_stream = nullptr

protected

is_auto_next

bool is_auto_next = true

protectedinherited

max

int max = 0

protected

mime

const char* mime = nullptr

protected

pos

int pos = 0

protected

started

bool started = false

protected

timeout_auto_next_value

int timeout_auto_next_value = 500

protectedinherited

urlArray

const char** urlArray = nullptr

protected

---

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

• src/AudioTools/Disk/AudioSourceURL.h