AudioTimerDriverRenesas Class Reference

Repeating Timer functions for repeated execution: Plaease use the typedef AudioTimer. By default we use a new GPT timer. You can also request 1 AGT timer by calling setTimer(1);. More...

#include <CodecOpusOgg.h>

Inheritance diagram for AudioTimerDriverRenesas:

Public Member Functions
	AudioTimerDriverRenesas ()
	AudioTimerDriverRenesas ()
bool	begin (const my_repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
bool	begin (const my_repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
void *	callbackParameter ()
void *	callbackParameter ()
bool	end ()
	ends the timer and if necessary the task
bool	end ()
	ends the timer and if necessary the task
void	setCallbackParameter (void *obj)
void	setCallbackParameter (void *obj)
virtual void	setIsSave (bool is_save)
	Not used.
virtual void	setIsSave (bool is_save)
	Not used.
void	setTimer (int timer) override
	Selects the timer type: 0=GPT and 1=AGT.
void	setTimer (int timer) override
	Selects the timer type: 0=GPT and 1=AGT.
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

Static Public Member Functions
static void	staticCallback (timer_callback_args_t *ptr)
static void	staticCallback (timer_callback_args_t *ptr)

Protected Member Functions
bool	startAGTTimer (float rate)
bool	startAGTTimer (float rate)
bool	startGPTTimer (float rate)
bool	startGPTTimer (float rate)
const char *	toString (TimeUnit unit)
const char *	toString (TimeUnit unit)

Protected Attributes
FspTimer	audio_timer
my_repeating_timer_callback_t	instanceCallback = nullptr
void *	object = nullptr
bool	timer_active = false
uint8_t	timer_type = 0

Detailed Description

Repeating Timer functions for repeated execution: Plaease use the typedef AudioTimer. By default we use a new GPT timer. You can also request 1 AGT timer by calling setTimer(1);.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioTimerDriverRenesas() [1/2]

AudioTimerDriverRenesas ( )

inline

AudioTimerDriverRenesas() [2/2]

AudioTimerDriverRenesas ( )

inline

Member Function Documentation

begin() [1/2]

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

inlineoverridevirtual

Starts the alarm timer

Implements AudioTimerDriverBase.

begin() [2/2]

bool begin ( const my_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 ( )

inlinevirtual

ends the timer and if necessary the task

Reimplemented from AudioTimerDriverBase.

end() [2/2]

bool end ( )

inlinevirtual

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]

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]

void setTimer ( int timer )

inlineoverridevirtual

Selects the timer type: 0=GPT and 1=AGT.

Reimplemented from AudioTimerDriverBase.

setTimer() [2/2]

void setTimer ( int timer )

inlineoverridevirtual

Selects the timer type: 0=GPT and 1=AGT.

Reimplemented from AudioTimerDriverBase.

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.

startAGTTimer() [1/2]

bool startAGTTimer ( float rate )

inlineprotected

startAGTTimer() [2/2]

bool startAGTTimer ( float rate )

inlineprotected

startGPTTimer() [1/2]

bool startGPTTimer ( float rate )

inlineprotected

startGPTTimer() [2/2]

bool startGPTTimer ( float rate )

inlineprotected

staticCallback() [1/2]

void staticCallback ( timer_callback_args_t * ptr )

inlinestatic

staticCallback() [2/2]

void staticCallback ( timer_callback_args_t * ptr )

inlinestatic

toString() [1/2]

const char * toString ( TimeUnit unit )

inlineprotectedinherited

toString() [2/2]

const char * toString ( TimeUnit unit )

inlineprotectedinherited

Member Data Documentation

audio_timer

FspTimer audio_timer

protected

instanceCallback

my_repeating_timer_callback_t instanceCallback = nullptr

protected

object

void * object = nullptr

protectedinherited

timer_active

bool timer_active = false

protected

timer_type

uint8_t timer_type = 0

protected

---

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

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