AudioTimerDriverSTM32 Class Reference

STM32 Repeating Timer functions for repeated execution: Please use the typedef AudioTimer. By default the TIM1 is used. More...

#include <CodecOpusOgg.h>

Inheritance diagram for AudioTimerDriverSTM32:

Public Member Functions
	AudioTimerDriverSTM32 ()
	AudioTimerDriverSTM32 ()
	~AudioTimerDriverSTM32 ()
	~AudioTimerDriverSTM32 ()
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.
void	setTimer (int timerIdx) override
	selects the timer: 0 = TIM1, 1 = TIM2,2 = TIM3, 3 = TIM4, 4 = TIM5
void	setTimer (int timerIdx) override
	selects the timer: 0 = TIM1, 1 = TIM2,2 = TIM3, 3 = TIM4, 4 = TIM5
void	setTimer (TIM_TypeDef *timerDef)
	select the timer
void	setTimer (TIM_TypeDef *timerDef)
	select the timer
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

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

Protected Attributes
void *	object = nullptr
HardwareTimer *	timer = nullptr
int	timer_index
TIM_TypeDef *	timers [6] = {TIM1, TIM2, TIM3, TIM4, TIM5}

Detailed Description

STM32 Repeating Timer functions for repeated execution: Please use the typedef AudioTimer. By default the TIM1 is used.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioTimerDriverSTM32() [1/2]

AudioTimerDriverSTM32 ( )

inline

~AudioTimerDriverSTM32() [1/2]

~AudioTimerDriverSTM32 ( )

inline

AudioTimerDriverSTM32() [2/2]

AudioTimerDriverSTM32 ( )

inline

~AudioTimerDriverSTM32() [2/2]

~AudioTimerDriverSTM32 ( )

inline

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

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/4]

void setTimer ( int timerIdx )

inlineoverridevirtual

selects the timer: 0 = TIM1, 1 = TIM2,2 = TIM3, 3 = TIM4, 4 = TIM5

Reimplemented from AudioTimerDriverBase.

setTimer() [2/4]

void setTimer ( int timerIdx )

inlineoverridevirtual

selects the timer: 0 = TIM1, 1 = TIM2,2 = TIM3, 3 = TIM4, 4 = TIM5

Reimplemented from AudioTimerDriverBase.

setTimer() [3/4]

void setTimer ( TIM_TypeDef * timerDef )

inline

select the timer

setTimer() [4/4]

void setTimer ( TIM_TypeDef * timerDef )

inline

select the timer

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

object

void * object = nullptr

protectedinherited

timer

HardwareTimer * timer = nullptr

protected

timer_index

int timer_index

protected

timers

TIM_TypeDef * timers = {TIM1, TIM2, TIM3, TIM4, TIM5}

protected

---

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

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