CMMFClockSourcePeriodicUtility Class Reference

#include "devvideobase.h"

Link against: devvideo.lib

class CMMFClockSourcePeriodicUtility : public CBase

Inherits from

CMMFClockSourcePeriodicUtility

Public Member Functions
	~CMMFClockSourcePeriodicUtility()
IMPORT_C CMMFClockSourcePeriodicUtility *	NewL(MMMFClockSource &, MMMFClockSourcePeriodicUtilityObserver &)
IMPORT_C void	Start(TTimeIntervalMicroSeconds32)
IMPORT_C void	Stop()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

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

Constructor & Destructor Documentation

~CMMFClockSourcePeriodicUtility ( )

IMPORT_C

~CMMFClockSourcePeriodicUtility

(

)

Destructor.

Member Function Documentation

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

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

Returns: "A new clock source periodic utility object."

Start ( TTimeIntervalMicroSeconds32 )

IMPORT_C void

Start

(

TTimeIntervalMicroSeconds32

aPeriod

)

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.

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

Stop ( )

IMPORT_C void

Stop

(

)

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