AudioTimerDriverESP8266 Class Reference

Repeating Timer functions for repeated execution: Plaease use the typedef AudioTimer. More...

#include <CodecOpusOgg.h>

Inheritance diagram for AudioTimerDriverESP8266:

Public Member Functions
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
void *	callbackParameter ()
void *	callbackParameter ()
bool	end () override
bool	end () override
void	setCallbackParameter (void *obj)
void	setCallbackParameter (void *obj)
virtual void	setIsSave (bool is_save)
	Not used.
virtual void	setIsSave (bool is_save)
	Not used.
virtual void	setTimer (int timer)
virtual void	setTimer (int timer)
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

Static Public Member Functions
static void	complexHandler (void *param)
static void	complexHandler (void *param)

Protected Member Functions
const char *	toString (TimeUnit unit)
const char *	toString (TimeUnit unit)

Protected Attributes
void(*	current_timer_callback )()
void *	object = nullptr
Ticker	ticker

Detailed Description

Repeating Timer functions for repeated execution: Plaease use the typedef AudioTimer.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin() [1/2]

bool begin ( repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit = MS )

inlineoverridevirtual

Starts the alarm timer

Implements AudioTimerDriverBase.

begin() [2/2]

bool begin ( repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit = MS )

inlineoverridevirtual

Starts the alarm timer

Implements AudioTimerDriverBase.

callbackParameter() [1/2]

void * callbackParameter ( )

inlineinherited

callbackParameter() [2/2]

void * callbackParameter ( )

inlineinherited

complexHandler() [1/2]

void complexHandler ( void * param )

inlinestatic

We can not do any I2C calls in the interrupt handler so we need to do this in a separate task

complexHandler() [2/2]

void complexHandler ( void * param )

inlinestatic

We can not do any I2C calls in the interrupt handler so we need to do this in a separate task

end() [1/2]

bool end ( )

inlineoverridevirtual

Reimplemented from AudioTimerDriverBase.

end() [2/2]

bool end ( )

inlineoverridevirtual

Reimplemented from AudioTimerDriverBase.

setCallbackParameter() [1/2]

void setCallbackParameter ( void * obj )

inlineinherited

setCallbackParameter() [2/2]

void setCallbackParameter ( void * obj )

inlineinherited

setIsSave() [1/2]

virtual void setIsSave ( bool is_save )

inlinevirtualinherited

Not used.

Reimplemented in AudioTimerDriverESP32, AudioTimerDriverESP32, AudioTimerDriverESP32Legacy, AudioTimerDriverESP32Legacy, AudioTimerDriverZephyr, AudioTimerDriverZephyr, AudioTimerDriverESP32, and AudioTimerDriverZephyr.

setIsSave() [2/2]

virtual void setIsSave ( bool is_save )

inlinevirtualinherited

Not used.

Reimplemented in AudioTimerDriverESP32, AudioTimerDriverESP32, AudioTimerDriverESP32Legacy, AudioTimerDriverESP32Legacy, AudioTimerDriverZephyr, AudioTimerDriverZephyr, AudioTimerDriverESP32, and AudioTimerDriverZephyr.

setTimer() [1/2]

virtual void setTimer ( int timer )

inlinevirtualinherited

Reimplemented in AudioTimerDriverESP32Legacy, AudioTimerDriverESP32Legacy, AudioTimerDriverRenesas, AudioTimerDriverRenesas, AudioTimerDriverSTM32, AudioTimerDriverSTM32, AudioTimerDriverRenesas, and AudioTimerDriverSTM32.

setTimer() [2/2]

virtual void setTimer ( int timer )

inlinevirtualinherited

Reimplemented in AudioTimerDriverESP32Legacy, AudioTimerDriverESP32Legacy, AudioTimerDriverRenesas, AudioTimerDriverRenesas, AudioTimerDriverSTM32, AudioTimerDriverSTM32, AudioTimerDriverRenesas, and AudioTimerDriverSTM32.

setTimerFunction() [1/2]

virtual void setTimerFunction ( TimerFunction function = DirectTimerCallback )

inlinevirtualinherited

Reimplemented in AudioTimerDriverESP32, AudioTimerDriverESP32, AudioTimerDriverESP32Legacy, AudioTimerDriverESP32Legacy, AudioTimerDriverZephyr, and AudioTimerDriverZephyr.

setTimerFunction() [2/2]

virtual void setTimerFunction ( TimerFunction function = DirectTimerCallback )

inlinevirtualinherited

Reimplemented in AudioTimerDriverESP32, AudioTimerDriverESP32, AudioTimerDriverESP32Legacy, AudioTimerDriverESP32Legacy, AudioTimerDriverZephyr, and AudioTimerDriverZephyr.

toString() [1/2]

const char * toString ( TimeUnit unit )

inlineprotectedinherited

toString() [2/2]

const char * toString ( TimeUnit unit )

inlineprotectedinherited

Member Data Documentation

current_timer_callback

void(* current_timer_callback)()

protected

object

void * object = nullptr

protectedinherited

ticker

Ticker ticker

protected

---

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

• src/AudioTools/AudioCodecs/CodecOpusOgg.h
• src/AudioTools/AudioCodecs/CodecTSDemux.h