CCamera::CCameraContinuousZoom Class Reference

#include <ecamadvsettings.h>

Link against: ecamadvsettings.lib

class CCamera::CCameraContinuousZoom : public CBase

Inherits from

CCamera::CCameraContinuousZoom

Public Member Functions
	~CCameraContinuousZoom()
IMPORT_C void	GetContinuousZoomId(TInt &)
IMPORT_C void	GetContinuousZoomSupportInfoL(CCamera::CCameraAdvancedSettings::TContinuousZoomSupportInfo &)
IMPORT_C void	StartContinuousZoomL(CCamera::CCameraAdvancedSettings::TContinuousZoomParameters)
IMPORT_C void	StopContinuousZoom()

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

This API is used to provide advanced continuous zoom support to the user.

This class is not directly created by the client but instead created via CCameraAdvancedSettings::CreateContinuousZoomL(). Ownership of the object is passed back to the client.

Note:

This class is not intended for sub-classing and used to standardise existing varieties of implementations.

If the class methods leave, the output type parameter value is not guaranteed to be valid.

Constructor & Destructor Documentation

~CCameraContinuousZoom ( )

IMPORT_C

~CCameraContinuousZoom

(

)

Destructor

Member Function Documentation

GetContinuousZoomId ( TInt & )

IMPORT_C void

GetContinuousZoomId

(

TInt &

aZoomId

)

const

Retrieves the unique id of the continuous zoom object. This is used to identify the continuous zoom handle returned to clients via the MContinuousZoomObserver callback.

Parameter	Description
aZoomId	The unique id of this Continuous Zoom object.

GetContinuousZoomSupportInfoL ( CCamera::CCameraAdvancedSettings::TContinuousZoomSupportInfo & )

IMPORT_C void

GetContinuousZoomSupportInfoL

(

CCamera::CCameraAdvancedSettings::TContinuousZoomSupportInfo &

aContinuousZoomInfo

)

const

Retrieves information about the supported settings related to continuous zoom support.

leave: May leave with any error code.

Parameter	Description
aContinuousZoomInfo	The information of supported continuous zoom functionality.

StartContinuousZoomL ( CCamera::CCameraAdvancedSettings::TContinuousZoomParameters )

IMPORT_C void

StartContinuousZoomL

(

CCamera::CCameraAdvancedSettings::TContinuousZoomParameters

aContinuousZoomParameters

)

Starts the continuous zoom operation. Clients wil receive MContinuousZoomObserver::ContinuousZoomProgress() callback for intermediate zoom factors achieved. Depending on the implementation, the client may or may not receive this callback for every intermediate zoom factor. Upon completion, the client will receive MContinuousZoomObserver::ContinuousZoomComplete() callback.

Note:

If the implementation does not support re-configuring of zoom parameters whilst an existing continuous zoom operation is active then StartContinuousZoomL() will leave with KErrInUse.

If client has selected EDirectionTele zoom direction and the current zoom factor is greater than the target zoom factor, StartContinuousZoomL() will leave with KErrArgument. Similarly, StartContinuousZoomL() will also leave with KErrArgument if client has selected EDirectionWide zoom direction and current zoom factor is less than target zoom factor.

leave: May leave with any error code.

Parameter	Description
aContinuousZoomParameters	The desired parameters to be used for the continuous zoom operation.

StopContinuousZoom ( )

IMPORT_C void

StopContinuousZoom

(

)

Stop any exisiting continuous zoom operation. Since this method is synchronous, no callback shall be issued for the concerned continuous zoom operation.