#include <juce_TimedCallback.h>
Public Member Functions | |
TimedCallback (std::function< void()> callbackIn) | |
~TimedCallback () noexcept override | |
void | startTimer (int intervalInMilliseconds) noexcept |
void | startTimerHz (int timerFrequencyHz) noexcept |
void | stopTimer () noexcept |
bool | isTimerRunning () const noexcept |
int | getTimerInterval () const noexcept |
Utility class wrapping a single non-null callback called by a Timer.
You can use the usual Timer functions to start and stop the TimedCallback. Deleting the TimedCallback will automatically stop the underlying Timer.
With this class you can use the Timer facility without inheritance.
Definition at line 39 of file juce_TimedCallback.h.
|
inlineexplicit |
Constructor. The passed in callback must be non-null.
Definition at line 43 of file juce_TimedCallback.h.
|
inlineoverridenoexcept |
Destructor.
Definition at line 50 of file juce_TimedCallback.h.
|
inlinenoexcept |
Returns the timer's interval.
Definition at line 116 of file juce_Timer.h.
|
inlinenoexcept |
Returns true if the timer is currently running.
Definition at line 111 of file juce_Timer.h.
|
noexcept |
Starts the timer and sets the length of interval required.
If the timer is already started, this will reset it, so the time between calling this method and the next timer callback will not be less than the interval length passed in.
intervalInMilliseconds | the interval to use (any value less than 1 will be rounded up to 1) |
Definition at line 90 of file juce_Timer.cpp.
|
noexcept |
Starts the timer with an interval specified in Hertz. This is effectively the same as calling startTimer (1000 / timerFrequencyHz).
Definition at line 95 of file juce_Timer.cpp.
|
noexcept |
Stops the timer.
No more timer callbacks will be triggered after this method returns.
Note that if you call this from a background thread while the message-thread is already in the middle of your callback, then this method will cancel any future timer callbacks, but it will return without waiting for the current one to finish. The current callback will continue, possibly still running some of your timer code after this method has returned.
Definition at line 107 of file juce_Timer.cpp.
Referenced by ~TimedCallback().