Class CMMFClockSourcePeriodicUtility

class CMMFClockSourcePeriodicUtility : public CBase;

Description

Utility class that can be used by video HW devices to receive periodic callbacks with the current time. Note that the exact timing of the callbacks cannot be guaranteed due to other things pre-empting the execution of the active object or thread.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CMMFClockSourcePeriodicUtility - Utility class that can be used by video HW devices to receive periodic callbacks with the current time

Members

Defined in CMMFClockSourcePeriodicUtility:
NewL(), Start(), Stop(), ~CMMFClockSourcePeriodicUtility()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CMMFClockSourcePeriodicUtility *NewL(MMMFClockSource &aClockSource, MMMFClockSourcePeriodicUtilityObserver &aObserver);

Description

Creates a new clock source periodic utility object.

Parameters

MMMFClockSource &aClockSource "A reference to the clock source to be used to query the current time." MMMFClockSourcePeriodicUtilityObserver &aObserver "A reference to the observer of the utility that will receive callbacks each time the specified period elapses."

Return value

CMMFClockSourcePeriodicUtility * "A new clock source periodic utility object."

Leave codes

"The method will leave if an error occurs."

IMPORT_C ~CMMFClockSourcePeriodicUtility();

Description

Destructor.

IMPORT_C void Start(TTimeIntervalMicroSeconds32 aPeriod);

Description

Starts the clock source periodic utility. The utility will call MmcspuoTick on its observer every aPeriod microseconds until Stop() is called. Note that the utility will not stop automatically when the clock source is stopped.

Parameters

TTimeIntervalMicroSeconds32 aPeriod "Defines the period with which the observer will receive callbacks."

IMPORT_C void Stop();

Description

Stops the clock source periodic utility. No more callbacks will be made after this method has been called.