Collapse all Symbian^3 Product Developer Library

MCameraOverlay2 Class Reference

class MCameraOverlay2

This is a mixin class to be implemented by providers of the camera extension API for extra features for image overlays.

CCamera::CCameraOverlay

Public Member Functions
void	GetAllOverlaysInZOrderL(CCamera::CCameraOverlay::TOverlayCameraMode, TInt, RArray< TUint > &)
void	Release()
void	SetAllOverlaysInZOrderL(CCamera::CCameraOverlay::TOverlayCameraMode, TInt, const RArray< TUint > &)
void	SetModifiableOverlayBitmapL(TUint, CFbsBitmap *)

Member Functions Documentation

GetAllOverlaysInZOrderL(CCamera::CCameraOverlay::TOverlayCameraMode, TInt, RArray< TUint > &)

void	GetAllOverlaysInZOrderL	(	CCamera::CCameraOverlay::TOverlayCameraMode	aOverlayCameraMode,
			TInt	aViewFinderHandle,
			RArray< TUint > &	aOverlayHandles
		)	const [pure virtual]

Gets all the overlay handles maintained by the ECam implementation, in order of their z-value, for a particular camera mode. If for viewfinder, then the handle number is used to get z-value for the viewfinder whose handle number is passed.

leave: May leave with any error code.

Parameters

CCamera::CCameraOverlay::TOverlayCameraMode aOverlayCameraMode	The specific camera mode whose overlays' z-value information is required.
TInt aViewFinderHandle	The specific viewfinder handle, if overlays' z-value information is required for viewfinder camera mode.
RArray< TUint > & aOverlayHandles	Returned list, in z-value order, of all the overlay handles maintained on the ECam implementation. The topmost overlay is the first element of the array.

Release()

void

Release

(

)

[pure virtual]

Releases the interface.

SetAllOverlaysInZOrderL(CCamera::CCameraOverlay::TOverlayCameraMode, TInt, const RArray< TUint > &)

void	SetAllOverlaysInZOrderL	(	CCamera::CCameraOverlay::TOverlayCameraMode	aOverlayCameraMode,
			TInt	aViewFinderHandle,
			const RArray< TUint > &	aOverlayHandles
		)	[pure virtual]

Sets all the overlay handles maintained by the ECam implementation, in order of their z-value, for a particular camera mode. If for viewfinder, then the handle number is used to set the z-value for the viewfinder whose handle number is passed.

leave: May leave with any error code.

Parameters

CCamera::CCameraOverlay::TOverlayCameraMode aOverlayCameraMode	The specific camera mode whose overlays' z-value is to be set.
TInt aViewFinderHandle	The specific viewfinder handle, if overlays' z-value is required to be set for viewfinder camera mode.
const RArray< TUint > & aOverlayHandles	The overlay handles in aOverlayHandles array. This must be the complete current set of handles known to this CCameraOverlay object for the given camera mode (and for given viewfinder, if applicable). The client specifies the desired order by placing the topmost overlay in the first element of the array.

SetModifiableOverlayBitmapL(TUint, CFbsBitmap *)

void	SetModifiableOverlayBitmapL	(	TUint	aOverlayHandle,
			CFbsBitmap *	aBitmap
		)	[pure virtual]

Allows the overlay image data to be changed for a specified overlay. Ownership of the bitmap is passed to the implementation. Use this function to set the overlay image data if it was not specified when the overlay was created using CreateOverlayL().

leave: May leave with any error code.

Note:

If required, implementation is free to modify the overlay bitmap passed to it.

SetOverlayParametersL should not be called after this method for the given overlay since it may change the overlay parameters considerably. In such a case, SetOverlayParametersL may leave with error KErrArgument.

Parameters

TUint aOverlayHandle	The handle of the overlay whose overlay image data is to be changed.
CFbsBitmap * aBitmap	The new image data for the overlay.