Collapse all Symbian^3 Application Developer Library

MCameraClientViewFinder Class Reference

class MCameraClientViewFinder

Mixin class for implementation of camera client viewfinder.

Public Member Functions
void	CreateHistogramImplFactoryL ( MImplementationFactory *&)
void	GetClientViewFinderPropertiesL ( TInt &, CCamera::TFormat &, TSize &, TRect &)
void	GetClientViewFinderStateL ( TBool &)
void	GetImageProcessingImplFactoryL ( MImplementationFactory *&)
void	GetViewFinderBufferL ( MCameraBuffer2 &)
void	Release ( CCamera::CCameraClientViewFinder *)
void	SetClientViewFinderHandle ( CCamera::CCameraClientViewFinder *)
void	SetClientViewFinderObserver ( MClientViewFinderObserver &)
void	StartClientViewFinderL ( TInt , CCamera::TFormat , TSize &)
void	StartClientViewFinderL ( TInt , CCamera::TFormat , TSize &, TRect &)
void	StopClientViewFinder ()

Member Functions Documentation

CreateHistogramImplFactoryL(MImplementationFactory *&)

void

CreateHistogramImplFactoryL

(

MImplementationFactory *&

aImplFactoryPtr

)

const [pure virtual]

Retrieves the concrete factory handle for the histogram implementation in order to use it specifically for a particular viewfinder.

leave: May leave with any error code.

Parameters

MImplementationFactory *& aImplFactoryPtr

The concrete factory handle for the histogram implementation specific to the given view finder.

GetClientViewFinderPropertiesL(TInt &, CCamera::TFormat &, TSize &, TRect &)

void	GetClientViewFinderPropertiesL	(	TInt &	aScreenNumber,
			CCamera::TFormat &	aImageFormat,
			TSize &	aSize,
			TRect &	aClipRect
		)	const [pure virtual]

Retrieves the parameters associated with the client viewfinder.

leave: May leave with any error code.

Parameters

TInt & aScreenNumber	Retrieves the screen number on which the client viewfinder is supposed to run.
CCamera::TFormat & aImageFormat	Retrieves the image format of the client viewfinder.
TSize & aSize	Retrieves the size used for the client viewfinder.
TRect & aClipRect	Retrieves the clip rectangle. If not specified, the clipping is retrieved as a TRect having origin as top left corner and the size as 'aSize'.

GetClientViewFinderStateL(TBool &)

void

GetClientViewFinderStateL

(

TBool &

aIsActive

)

const [pure virtual]

Retrieves the state of the client viewfinder.

leave: May leave with any error code.

Parameters

TBool & aIsActive

ETrue indicates that client viewfinder is active. EFalse indicates that client viewfinder is not active.

GetImageProcessingImplFactoryL(MImplementationFactory *&)

void

GetImageProcessingImplFactoryL

(

MImplementationFactory *&

aImplFactoryPtr

)

const [pure virtual]

Retrieves the concrete factory handle for the image processing implementation in order to use it specifically for a particular viewfinder.

leave: May leave with any error code.

Parameters

MImplementationFactory *& aImplFactoryPtr

The concrete factory handle for the image processing implementation specific to the given view finder.

GetViewFinderBufferL(MCameraBuffer2 &)

void

GetViewFinderBufferL

(

MCameraBuffer2 &

aClientViewFinderBuffer

)

const [pure virtual]

Retrieves the client viewfinder buffer. Client calls this method after being notified about availability of viewfinder data via MClientViewFinderObserver::ViewFinderBufferReady() .

leave: May leave with any error code.

Parameters

MCameraBuffer2 & aClientViewFinderBuffer

Reference to MCameraBuffer2 which retrieves the client viewfinder data.

Release(CCamera::CCameraClientViewFinder *)

void

Release

(

CCamera::CCameraClientViewFinder *

aClientViewFinderHandle

)

[pure virtual]

Releases the interface.

Parameters

CCamera::CCameraClientViewFinder * aClientViewFinderHandle

The pointer to the client viewfinder class object which would be destroyed by the client.

SetClientViewFinderHandle(CCamera::CCameraClientViewFinder *)

void

SetClientViewFinderHandle

(

CCamera::CCameraClientViewFinder *

aClientViewFinderHandle

)

[pure virtual]

The pointer to the client view finder class used to pass back to the client via observer callbacks. Implementation is not supposed to destroy this object.

MClientViewFinderObserver

Parameters

CCamera::CCameraClientViewFinder * aClientViewFinderHandle

SetClientViewFinderObserver(MClientViewFinderObserver &)

void

SetClientViewFinderObserver

(

MClientViewFinderObserver &

aClientViewFinderObserver

)

[pure virtual]

The observer for the client view finder is passed to the implementation for passing callbacks on it.

Parameters

MClientViewFinderObserver & aClientViewFinderObserver

The reference to the client view finder observer.

StartClientViewFinderL(TInt, CCamera::TFormat, TSize &)

void	StartClientViewFinderL	(	TInt	aScreenNumber,
			CCamera::TFormat	aImageFormat,
			TSize &	aSize
		)	[pure virtual]

Creates a new viewfinder and starts transfer of view finder data.

Availability of viewfinder data is notified by MClientViewFinderObserver::ViewFinderBufferReady() .

leave: May leave with any error code.

Note:

KECamDefaultViewFinderHandle is used to refer to the viewfinder started using CCamera methods.

CCamera::StartViewFinderL(TFormat aImageFormat,TSize& aSize)

Parameters

TInt aScreenNumber	The screen number on which the client viewfinder is supposed to run.
CCamera::TFormat aImageFormat	The image format requested by the client.
TSize & aSize	On return, the size used. The size may be modified by the implementation because of hardware constraints and byte alignment.

StartClientViewFinderL(TInt, CCamera::TFormat, TSize &, TRect &)

void	StartClientViewFinderL	(	TInt	aScreenNumber,
			CCamera::TFormat	aImageFormat,
			TSize &	aSize,
			TRect &	aClipRect
		)	[pure virtual]

Creates a new viewfinder and starts transfer of view finder data. Also, clips the picture to the specified clip rectangle.

Availability of viewfinder data is notified by MClientViewFinderObserver::ViewFinderBufferReady() .

The picture is the size of the intersection of aSize and aClipRect, not simply aSize padded with white space.

leave: May leave with any error code.

Note:

KECamDefaultViewFinderHandle is used to refer viewfinder started using CCamera methods.

CCamera::StartViewFinderL(TFormat aImageFormat,TSize& aSize,TRect& aClipRect)

Parameters

TInt aScreenNumber	The screen number on which the client viewfinder is supposed to run.
CCamera::TFormat aImageFormat	The image format.
TSize & aSize	On return, the size used. The size may be modified by the implementation because of hardware constraints and byte alignment.
TRect & aClipRect	Required clip rectangle. May be modified if, for example, the camera only supports certain byte alignments.

StopClientViewFinder()

void

StopClientViewFinder

(

)

[pure virtual]

Stop the client viewfinder.