AudioTimerDriverESP32 Class Reference

Repeating Timer functions for simple scheduling of repeated execution using esp_timer_create(). More...

#include <CodecOpusOgg.h>

Inheritance diagram for AudioTimerDriverESP32:

Public Member Functions
virtual	~AudioTimerDriverESP32 ()
virtual	~AudioTimerDriverESP32 ()
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
	Starts the alarm timer.
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
	Starts the alarm timer.
void *	callbackParameter ()
void *	callbackParameter ()
bool	end () override
	ends the timer and if necessary the task
bool	end () override
	ends the timer and if necessary the task
void	setCallbackParameter (void *obj)
void	setCallbackParameter (void *obj)
void	setIsSave (bool is_save) override
	Not used.
void	setIsSave (bool is_save) override
	Not used.
virtual void	setTimer (int timer)
virtual void	setTimer (int timer)
void	setTimerFunction (TimerFunction function) override
void	setTimerFunction (TimerFunction function) override

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

Protected Attributes
void *	object = nullptr
esp_timer_handle_t	rtsp_timer = nullptr
uint64_t	time_us = 0
TimerFunction	timer_function = TimerCallbackInThread

Detailed Description

Repeating Timer functions for simple scheduling of repeated execution using esp_timer_create().

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

~AudioTimerDriverESP32() [1/2]

virtual ~AudioTimerDriverESP32 ( )

inlinevirtual

~AudioTimerDriverESP32() [2/2]

virtual ~AudioTimerDriverESP32 ( )

inlinevirtual

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

end() [1/2]

bool end ( )

inlineoverridevirtual

ends the timer and if necessary the task

Reimplemented from AudioTimerDriverBase.

end() [2/2]

bool end ( )

inlineoverridevirtual

ends the timer and if necessary the task

Reimplemented from AudioTimerDriverBase.

setCallbackParameter() [1/2]

void setCallbackParameter ( void * obj )

inlineinherited

setCallbackParameter() [2/2]

void setCallbackParameter ( void * obj )

inlineinherited

setIsSave() [1/2]

void setIsSave ( bool is_save )

inlineoverridevirtual

Not used.

Reimplemented from AudioTimerDriverBase.

setIsSave() [2/2]

void setIsSave ( bool is_save )

inlineoverridevirtual

Not used.

Reimplemented from AudioTimerDriverBase.

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]

void setTimerFunction ( TimerFunction function )

inlineoverridevirtual

Reimplemented from AudioTimerDriverBase.

setTimerFunction() [2/2]

void setTimerFunction ( TimerFunction function )

inlineoverridevirtual

Reimplemented from AudioTimerDriverBase.

toString() [1/2]

const char * toString ( TimeUnit unit )

inlineprotectedinherited

toString() [2/2]

const char * toString ( TimeUnit unit )

inlineprotectedinherited

Member Data Documentation

object

void * object = nullptr

protectedinherited

rtsp_timer

esp_timer_handle_t rtsp_timer = nullptr

protected

time_us

uint64_t time_us = 0

protected

timer_function

TimerFunction timer_function = TimerCallbackInThread

protected

---

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

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