Base Module  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Timer Class Referenceabstract

Timer is a class that allows you to receive triggers at regular intervals. More...

#include <timer.h>

+ Inheritance diagram for Timer:

Public Member Functions

virtual void stop ()=0
 Stop the timer. More...
 
- Public Member Functions inherited from FObject
 FObject ()
 default constructor... More...
 
 FObject (const FObject &)
 overloaded constructor... More...
 
virtual ~FObject ()
 destructor... More...
 
FObjectoperator= (const FObject &)
 overloads operator "=" as the reference assignment More...
 
virtual FClassID isA () const
 a local alternative to getFClassID () More...
 
virtual bool isA (FClassID s) const
 evaluates if the passed ID is of the FObject type More...
 
virtual bool isTypeOf (FClassID s, bool=true) const
 evaluates if the passed ID is of the FObject type More...
 
int32 getRefCount ()
 returns the current interface reference count More...
 
FUnknown * unknownCast ()
 get FUnknown interface from object More...
 
virtual tresult queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
 please refer to FUnknown::queryInterface () More...
 
virtual uint32 addRef () SMTG_OVERRIDE
 please refer to FUnknown::addref () More...
 
virtual uint32 release () SMTG_OVERRIDE
 please refer to FUnknown::release () More...
 
virtual void update (FUnknown *, int32) SMTG_OVERRIDE
 empty virtual method that should be overridden by derived classes for data updates upon changes More...
 
virtual void addDependent (IDependent *dep)
 adds dependency to the object More...
 
virtual void removeDependent (IDependent *dep)
 removes dependency from the object More...
 
virtual void changed (int32 msg=kChanged)
 Inform all dependents, that the object has changed. More...
 
virtual void deferUpdate (int32 msg=kChanged)
 Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates). More...
 
virtual void updateDone (int32)
 empty virtual method that should be overridden by derived classes More...
 
virtual bool isEqualInstance (FUnknown *d)
 

Static Public Member Functions

static Timercreate (ITimerCallback *callback, uint32 intervalMilliseconds)
 Create a timer with a given interval. More...
 
- Static Public Member Functions inherited from FObject
static FClassID getFClassID ()
 return Class ID as an ASCII string (statically) More...
 
static void setUpdateHandler (IUpdateHandler *handler)
 set method for the local attribute More...
 
static IUpdateHandler * getUpdateHandler ()
 get method for the local attribute More...
 
static bool classIDsEqual (FClassID ci1, FClassID ci2)
 compares (evaluates) 2 class IDs More...
 
static FObjectunknownToObject (FUnknown *unknown)
 pointer conversion from FUnknown to FObject More...
 

Additional Inherited Members

- Static Public Attributes inherited from FObject
static const FUID iid
 Special UID that is used to cast an FUnknown pointer to a FObject. More...
 
- Protected Attributes inherited from FObject
int32 refCount
 COM-model local reference count. More...
 
- Static Protected Attributes inherited from FObject
static IUpdateHandler * gUpdateHandler = 0
 

Detailed Description

Timer is a class that allows you to receive triggers at regular intervals.

Note: The timer class is an abstract base class with (hidden) platform specific subclasses.

Usage:

class TimerReceiver : public FObject, public ITimerCallback
{
...
virtual void onTimer (Timer* timer)
{
// do stuff
}
...
};
TimerReceiver* receiver = new TimerReceiver ();
Timer* myTimer = Timer::create (receiver, 100); // interval: every 100ms
...
...
if (myTimer)
myTimer->release ();
if (receiver)
receiver->release ();
See also
ITimerCallback

Member Function Documentation

static Timer* create ( ITimerCallback callback,
uint32  intervalMilliseconds 
)
static

Create a timer with a given interval.

Parameters
callbackThe receiver of the timer calls.
intervalMillisecondsThe timer interval in milliseconds.
Returns
The created timer if any, callers owns the timer. The timer starts immediately.
virtual void stop ( )
pure virtual

Stop the timer.

Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.