AudioSourceCallback Class Reference

Callback Audio Data Source which is used by the Audio Players. More...

#include <AudioSource.h>

Inheritance diagram for AudioSourceCallback:

Public Member Functions
	AudioSourceCallback ()
	AudioSourceCallback (Stream *(*nextStreamCallback)(int offset), void(*onStartCallback)()=nullptr)
virtual bool	begin () override
	Reset actual stream and move to root.
virtual const char *	getPath ()
	Returns the requested path: relevant when provided idx in callback is -1.
virtual int	index ()
	Returns the actual index of the stream.
virtual bool	isAutoNext () override
	Returns default setting go to the next.
virtual Stream *	nextStream (int offset) override
Stream *	operator[] (int idx)
	access with array syntax
virtual Stream *	previousStream (int offset)
	Returns previous audio stream.
virtual Stream *	selectStream (const char *path) override
	Returns audio stream by path.
virtual Stream *	selectStream (int index) override
	Returns selected audio stream.
virtual void	setAutoNext (bool a)
void	setCallbackNextStream (Stream *(*callback)(int offset))
void	setCallbackOnStart (void(*callback)())
void	setCallbackSelectStream (Stream *(*callback)(int idx))
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 stream (e.g. file) name or url

Protected Attributes
bool	auto_next = true
Stream *(*	indexStreamCallback )(int index) = nullptr
bool	is_auto_next = true
Stream *(*	nextStreamCallback )(int offset) = nullptr
void(*	onStartCallback )() = nullptr
const char *	path = nullptr
int	timeout_auto_next_value = 500

Detailed Description

Callback Audio Data Source which is used by the Audio Players.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioSourceCallback() [1/2]

AudioSourceCallback ( )

inline

AudioSourceCallback() [2/2]

AudioSourceCallback ( Stream *(* nextStreamCallback )(int offset), void(* onStartCallback )() = nullptr )

inline

Member Function Documentation

begin()

virtual bool begin ( )

inlineoverridevirtual

Reset actual stream and move to root.

Implements AudioSource.

getPath()

virtual const char * getPath ( )

inlinevirtual

Returns the requested path: relevant when provided idx in callback is -1.

index()

virtual int index ( )

inlinevirtualinherited

Returns the actual index of the stream.

Reimplemented in AudioSourceArray< FileType >, AudioSourceFTP< ClientType >, AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSMB, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVector< FileType >, and AudioSourceVFS.

isAutoNext()

virtual bool isAutoNext ( )

inlineoverridevirtual

Returns default setting go to the next.

Reimplemented from AudioSource.

nextStream()

virtual Stream * nextStream ( int offset )

inlineoverridevirtual

Returns next (with positive index) or previous stream (with negative index)

Implements AudioSource.

operator[]()

Stream * operator[] ( int idx )

inlineinherited

access with array syntax

previousStream()

virtual Stream * previousStream ( int offset )

inlinevirtualinherited

Returns previous audio stream.

Reimplemented in AudioSourceFTP< ClientType >, AudioSourceSMB, and AudioSourceURL.

selectStream() [1/2]

virtual Stream * selectStream ( const char * path )

inlineoverridevirtual

Returns audio stream by path.

Implements AudioSource.

selectStream() [2/2]

virtual Stream * selectStream ( int index )

inlineoverridevirtual

Returns selected audio stream.

Reimplemented from AudioSource.

setAutoNext()

virtual void setAutoNext ( bool a )

inlinevirtual

Reimplemented from AudioSource.

setCallbackNextStream()

void setCallbackNextStream ( Stream *(* callback )(int offset) )

inline

setCallbackOnStart()

void setCallbackOnStart ( void(* callback )() )

inline

setCallbackSelectStream()

void setCallbackSelectStream ( Stream *(* callback )(int idx) )

inline

setIndex()

virtual Stream * setIndex ( int index )

inlinevirtualinherited

same as selectStream - I just prefer this name

setMetadataCallback()

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

inlinevirtualinherited

Reimplemented in AudioSourceURL.

setTimeout()

virtual void setTimeout ( int millisec )

inlinevirtualinherited

Sets the timeout of Stream in milliseconds.

Reimplemented in AudioSourceURL.

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

timeoutAutoNext()

virtual int timeoutAutoNext ( )

inlinevirtualinherited

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

toStr()

virtual const char * toStr ( )

inlinevirtualinherited

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

Reimplemented in AudioSourceArray< FileType >, AudioSourceFTP< ClientType >, AudioSourceIdxSD, AudioSourceIdxSDFAT< AudioFs, AudioFile >, AudioSourceIdxSDMMC, AudioSourceLittleFS, AudioSourceSD, AudioSourceSDFAT< AudioFs, AudioFile >, AudioSourceSDMMC, AudioSourceSMB, AudioSourceSPIFFS, AudioSourceSTD, AudioSourceURL, AudioSourceVector< FileType >, and AudioSourceVFS.

Member Data Documentation

auto_next

bool auto_next = true

protected

indexStreamCallback

Stream *(* indexStreamCallback) (int index) = nullptr

protected

is_auto_next

bool is_auto_next = true

protectedinherited

nextStreamCallback

Stream *(* nextStreamCallback) (int offset) = nullptr

protected

onStartCallback

void(* onStartCallback) () = nullptr

protected

path

const char* path = nullptr

protected

timeout_auto_next_value

int timeout_auto_next_value = 500

protectedinherited

---

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

• src/AudioTools/Disk/AudioSource.h