arduino-audio-tools
Public Member Functions | Protected Attributes | List of all members
TimerAlarmRepeating Class Reference

Common Interface definition for TimerAlarmRepeating. More...

#include <AudioTimer.h>

Public Member Functions

 TimerAlarmRepeating ()=default
 Default constructor.
 
 TimerAlarmRepeating (TimerAlarmRepeatingDriverBase &timer)
 Construct a new Timer Alarm Repeating object by passing your object which has been customized with some special platform specific parameters. More...
 
bool begin (repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS)
 
void * callbackParameter ()
 
TimerAlarmRepeatingDriverBasedriver ()
 Provides access to the driver.
 
bool end ()
 
 operator bool ()
 Returns true if the timer is active.
 
void setCallbackParameter (void *obj)
 
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
 
TimerAlarmRepeatingDriverBasep_timer = &timer
 
TimerAlarmRepeatingDriver timer
 

Detailed Description

Common Interface definition for TimerAlarmRepeating.

Constructor & Destructor Documentation

◆ TimerAlarmRepeating()

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

Parameters
timer

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