CMMFClockSourcePeriodicUtility Class Reference

class CMMFClockSourcePeriodicUtility : public CBase

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.

Inherits from

  • CMMFClockSourcePeriodicUtility

Constructor & Destructor Documentation

CMMFClockSourcePeriodicUtility(MMMFClockSource &, MMMFClockSourcePeriodicUtilityObserver &)

CMMFClockSourcePeriodicUtility(MMMFClockSource &aClockSource,
MMMFClockSourcePeriodicUtilityObserver &aObserver
)[private]

Parameters

MMMFClockSource & aClockSource
MMMFClockSourcePeriodicUtilityObserver & aObserver

~CMMFClockSourcePeriodicUtility()

IMPORT_C~CMMFClockSourcePeriodicUtility()

Destructor.

Member Functions Documentation

Callback(TAny *)

TInt Callback(TAny *aAny)[private, static]

Parameters

TAny * aAny

ConstructL()

voidConstructL()[private]

DoCallback()

voidDoCallback()[private]

NewL(MMMFClockSource &, MMMFClockSourcePeriodicUtilityObserver &)

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

Creates a new clock source periodic utility object.

leave
"The method will leave if an error occurs."

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."

Start(TTimeIntervalMicroSeconds32)

IMPORT_C voidStart(TTimeIntervalMicroSeconds32aPeriod)

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."

Stop()

IMPORT_C voidStop()

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

Member Data Documentation

MMMFClockSource & iClockSource

MMMFClockSource &iClockSource[private]

MMMFClockSourcePeriodicUtilityObserver & iObserver

MMMFClockSourcePeriodicUtilityObserver &iObserver[private]

CPeriodic * iTimer

CPeriodic *iTimer[private]