AudioTimer Class Reference

Common Interface definition for AudioTimer. More...

#include <AudioTimer.h>

Public Member Functions
	AudioTimer ()=default
	Default constructor.
	AudioTimer (AudioTimerDriverBase &timer)
	Construct a new Timer Alarm Repeating object by passing your object which has been customized with some special platform specific parameters.
virtual	~AudioTimer ()=default
bool	begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS)
void *	callbackParameter ()
AudioTimerDriverBase *	driver ()
	Provides access to the driver.
bool	end ()
	operator bool ()
	Returns true if the timer is active.
void	setCallbackParameter (void *obj)
void	setDriver (AudioTimerDriverBase &timer)
	Allows to set a different driver.
void	setIsSave (bool is_save)
virtual void	setTimer (int timer)
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

Protected Attributes
bool	is_active = false
void *	object = nullptr
AudioTimerDriverBase *	p_timer = &timer
AudioTimerDriver	timer

Detailed Description

Common Interface definition for AudioTimer.

Constructor & Destructor Documentation

AudioTimer() [1/2]

AudioTimer ( )

default

Default constructor.

AudioTimer() [2/2]

AudioTimer ( AudioTimerDriverBase &  timer )

inline

Construct a new Timer Alarm Repeating object by passing your object which has been customized with some special platform specific parameters.

Parameters

timer

~AudioTimer()

virtual ~AudioTimer ( )

virtualdefault

Member Function Documentation

begin()

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

inline

callbackParameter()

void * callbackParameter ( )

inline

driver()

AudioTimerDriverBase * driver ( )

inline

Provides access to the driver.

end()

bool end ( )

inline

operator bool()

operator bool ( )

inline

Returns true if the timer is active.

setCallbackParameter()

void setCallbackParameter ( void *  obj )

inline

setDriver()

void setDriver ( AudioTimerDriverBase &  timer )

inline

Allows to set a different driver.

setIsSave()

void setIsSave ( bool  is_save )

inline

setTimer()

virtual void setTimer ( int  timer )

inlinevirtual

setTimerFunction()

virtual void setTimerFunction ( TimerFunction  function = DirectTimerCallback )

inlinevirtual

Member Data Documentation

is_active

bool is_active = false

protected

object

void* object = nullptr

protected

p_timer

AudioTimerDriverBase* p_timer = &timer

protected

timer

AudioTimerDriver timer

protected

---

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

• src/AudioTools/CoreAudio/AudioTimer/AudioTimer.h