CCamera::CCameraPreImageCaptureControl::TImageBufferInfo Class Reference

class CCamera::CCameraPreImageCaptureControl::TImageBufferInfo

Provides information regarding streamed image buffers or sub-frames.

Constructor & Destructor Documentation

TImageBufferInfo()

IMPORT_C TImageBufferInfo ( )

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

Member Functions Documentation

IsParallelStreamedBufferUsed()

IMPORT_C TBool IsParallelStreamedBufferUsed ( ) const

Indicates whether the parallel buffering is being used by the implementation in order to speed up the streamed image operation, as a whole.

Note:

Parallel buffering indicates that implementation is using more than one buffer to handle the various sub-frames; hence speeding up the operation.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iIsParallelBufferUsed

IsSubFrameUsed()

IMPORT_C TBool IsSubFrameUsed ( ) const

Indicates whether the streamed image scheme or sub-frame scheme is being used.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iIsSubFrameUsed

SetParallelStreamedBufferState(TBool)

IMPORT_C void SetParallelStreamedBufferState ( TBool aIsParallelStreamedBufferUsed )

Sets the state to inform whether the parallel buffering is being used by the implementation in order to speed up the streamed image operation, as a whole.

Note:

The set method will be used by the ECAM implementation in order to provide necessary information to the clients when they receive the image buffers.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iIsParallelBufferUsed

Parameters

TBool aIsParallelStreamedBufferUsed ETrue implies sub-frame scheme is being used. EFalse implies sub-frame scheme is not being used.

SetSubFrameSequenceNumber(TUint)

IMPORT_C TInt SetSubFrameSequenceNumber ( TUint aSubFrameSequenceNumber )

Sets the sequence number of the sub-frame.

Note:

9 bits used for sequence no. assuming that KECamMaxTotalSubFrames sub-frames would be used at max. Sequence number for sub-frames lies between 0 to KECamMaxTotalSubFrames-1 inclusive.

The set method will be used by the ECAM implementation in order to provide necessary information to the clients when they receive the image buffers.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iSubFrameSequenceNumber

Parameters

TUint aSubFrameSequenceNumber The sequence number of the sub-frame.

SetSubFrameState(TBool)

IMPORT_C void SetSubFrameState ( TBool aIsSubFrameUsed )

Sets the state to inform whether the streamed image scheme or sub-frame scheme is being used.

Note:

The set method will be used by the ECAM implementation in order to provide necessary information to the clients when they receive the image buffers.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iIsSubFrameUsed

Parameters

TBool aIsSubFrameUsed ETrue implies sub-frame scheme is being used. EFalse implies sub-frame scheme is not being used.

SetTotalSubFrames(TUint)

IMPORT_C TInt SetTotalSubFrames ( TUint aTotalSubFrames )

Sets the total number of sub-frames needed in order to properly reconstruct the actual image.

Note:

It does not give the number of outstanding sub-frames needed to reconstruct the image. This value will be same for every sub-frames needed to re-construct the actual image. Maximum no. of total sub-frames is KECamMaxTotalSubFrames.

The set method will be used by the ECAM implementation in order to provide necessary information to the clients when they receive the image buffers.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iTotalSubFrames

Parameters

TUint aTotalSubFrames Total number of sub-frames which can reconstruct the actual image.

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 in such cases after the old implementation detects this by getting the size information of the T class passed. Also, if old application is made to run on a new implementation, this could be properly 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.

SubFrameSequenceNumber()

IMPORT_C TUint SubFrameSequenceNumber ( ) const

TotalSubFrames()

IMPORT_C TUint TotalSubFrames ( ) const

Total number of sub-frames needed in order to properly reconstruct the actual image.

Note:

It does not give the number of outstanding sub-frames needed to reconstruct the image. This value will be same for every sub-frames needed to re-construct the actual image. Maximum no. of total sub-frames is KECamMaxTotalSubFrames.

CCamera::CCameraPreImageCaptureControl::TImageBufferInfo::iTotalSubFrames

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

TPrepareImageParameters iImageParameters

TPrepareImageParameters iImageParameters

The parameters used for this image

TUint iIsParallelBufferUsed

TUint iIsParallelBufferUsed [private]

Indicates whether the parallel buffering is being used by the implementation in order to speed up the streamed image operation, as a whole. One bit is enough to provide such information. Parallel buffering indicates that implementation is using more than one buffer to handle the various sub-frames; hence speeding up the operation.

TUint iIsSubFrameUsed

TUint iIsSubFrameUsed [private]

Indicates whether the streamed image scheme or sub-frame scheme is being used. One bit is enough to provide such information

TInt iReserved1

TInt iReserved1 [private]

TInt iReserved2

TInt iReserved2 [private]

TInt iReserved3

TInt iReserved3 [private]

TInt iReserved4

TInt iReserved4 [private]

TInt iReserved5

TInt iReserved5 [private]

TInt iReserved6

TInt iReserved6 [private]

TUint iReservedBits

TUint iReservedBits [private]

TUint iSize

TUint iSize [private]

TRect iSubFramePosition

TRect iSubFramePosition

The exact position of the sub-frame within the actual image frame. The actual image frame's bounding rectangle is defined by origin as top-left and TSize parameter used to prepare the image capture.

TUint iSubFrameSequenceNumber

TUint iSubFrameSequenceNumber [private]

Sequence number of the sub-frame. 9 bits used for sequence no. assuming that KECamMaxTotalSubFrames sub-frames would be used at max

TUint iTotalSubFrames

TUint iTotalSubFrames [private]

Total number of sub-frames to be retrieved by the client in order to properly reconstruct the actual image. It does not give the number of outstanding sub-frames needed to reconstruct the image. This value will be same for every sub-frames needed to re-construct the actual image. Maximum no. of total sub-frames is KECamMaxTotalSubFrames.

TUint iVersion

TUint iVersion [private]