CCamera::CCameraSnapshot::TSnapshotParameters Class Reference

class CCamera::CCameraSnapshot::TSnapshotParameters

Specifes the parameters necessary for client snapshots.

Constructor & Destructor Documentation

TSnapshotParameters()

IMPORT_C TSnapshotParameters ( )

Constructor for the TSnapshotParameters class. Sets the size and version of this class.

Member Functions Documentation

IsAspectRatioMaintained()

IMPORT_C TBool IsAspectRatioMaintained ( ) const

Indicates whether the aspect ratio of the snapshot image has to maintained (if ETrue) or not (if EFalse) while scaling down.

CCamera::CCameraSnapshot::TSnapshotParameters::iIsAspectRatioMaintained

SetAspectRatioState(TBool)

IMPORT_C void SetAspectRatioState ( TBool aIsAspectRatioMaintained )

Sets the state to inform whether the aspect ratio of the snapshot image has to be maintained or not while scaling down.

CCamera::CCameraSnapshot::TSnapshotParameters::iIsAspectRatioMaintained

Parameters

TBool aIsAspectRatioMaintained ETrue implies must be maintained, EFalse otherwise.

Size()

IMPORT_C TUint Size ( ) const

Returns the size of the class. Used for extensibility by deriving from this base class and adding new member variables. Intended to be used for implementation of methods where this class reference is passed as function arguments. Implementation of such methods can find out the whether the actual class passed is base or the derived one. So, if a new application is made to run on an old implementation, an error may occur once the old implementation detects this by getting the size information of the T class passed. Also, if an old application is made to run on a new implementation, this can be corrrectly handled if the derived class variables handling is done in a proper 'if-else' statement.

Note:

The size will be modified when the T-class gets updated.

Version()

IMPORT_C TUint Version ( ) const

Returns the version of the class. Used for extensibility specially when the class members are not added but the Reserved members get used at a later stage.

Note:

The version will be modified when the T-class gets updated.

Member Data Documentation

CCamera::TFormat iFormat

CCamera::TFormat iFormat

The image format that the snapshot must have.

TUint iIsAspectRatioMaintained

TUint iIsAspectRatioMaintained [private]

Set to ETrue if the aspect ratio of the snapshot image must be maintained when scaling down

TPoint iPosition

TPoint iPosition

The top left corner position (in pixels) which determines the layout of the snapshot image within the dimensions provided by the iSnapshotSize parameter when the snapshot has been scaled maintaining its aspect ratio. ECam implementation is supposed to calculate the proportion between the top left corner and the snapshot size and hence use it, in case, the snapshot size used is different.

TInt iReserved1

TInt iReserved1 [private]

TInt iReserved2

TInt iReserved2 [private]

TInt iReserved3

TInt iReserved3 [private]

TUint iReserved4

TUint iReserved4 [private]

TInt iReserved5

TInt iReserved5 [private]

TInt iReserved6

TInt iReserved6 [private]

TInt iReserved7

TInt iReserved7 [private]

TUint iSize

TUint iSize [private]

TSize iSnapshotSize

TSize iSnapshotSize

The size of the snapshot in pixels. The snapshot size may be changed by the implementation to meet hardware requirements, performance etc.

TUint iVersion

TUint iVersion [private]