Symbian^3 Application Developer Library >

CCaeEngine Class Reference

class CCaeEngine : public CBase

The Camera Application Engine interface (abstract base class).

CAEENGINE.LIB
Since
2.1

Inherits from

Public Member Functions
TInt Brightness ()
TInt CCameraHandle ()
IMPORT_C TInt CamerasAvailable ()
void CancelCaptureStill ()
void CaptureStill ()
void CloseVideoRecording ()
TInt Contrast ()
TAny * CustomInterface ( TUid )
void DisableVideoRecording ()
void EnableVideoRecording ()
void EnumerateStillCaptureSizes ( TSize &, TInt , CCamera::TFormat )
TInt EnumerateVideoFrameSizeL (const TSize &)
TInt EstimatedStillSizeInBytes ( TInt )
TInt EstimatedVideoRecordingBitRateL ( TInt )
TInt EvCompensation ()
CCamera::TExposure ExposureMode ()
CCamera::TFlash FlashMode ()
void GetInfo ( TCamAppEngineInfo &)
void GetOrderL ( RCaeOrderedFeatureList &)
void GetStillFrameSize ( TInt , TSize &)
void GetVideoFrameSize ( TInt , TSize &)
void GetViewFinderSize ( TSize &)
void InitL ( TBool )
void InitL ( TUid , TBool )
void InitVideoRecorderL ()
void InitVideoRecorderL ( TUid )
TBool IsVideoRecording ()
TBool IsViewFinding ()
TInt JpegQuality ()
IMPORT_C CCaeEngine * NewL ()
IMPORT_C CCaeEngine * NewL ( TInt )
IMPORT_C CCaeEngine * NewL ( TInt , TInt )
void PauseVideoRecording ()
void PowerOff ()
void PowerOn ()
void PrepareStillCaptureL ( TInt )
void PrepareStillCaptureL ( TInt , const TRect &)
void PrepareStillCaptureL (const TSize &, CCamera::TFormat , TInt )
void PrepareStillCaptureL (const TSize &, CCamera::TFormat , TInt , const TRect &)
void PrepareStillCaptureL ( TInt , TSize &)
void PrepareStillCaptureL (const TSize &, CCamera::TFormat , TInt , const TRect &, TSize &)
void PrepareVideoRecordingL ( TInt )
void PrepareVideoRecordingL (const TSize &, TReal32 , TInt , TBool , const TDesC8 &, const TDesC &, const TDesC8 &, const TDesC8 &)
void PrepareVideoRecordingL (const TSize &, TReal32 , TInt , TBool , TInt , const TDesC8 &, const TDesC &, const TDesC8 &, const TDesC8 &)
void ProcessExtCancel ()
void ProcessExtCapturedImageL ( CFbsBitmap &, TBool )
void ProcessExtCapturedImageL ( HBufC8 *, TBool )
void ProcessExtCapturedImageL ( TDesC8 &, TBool )
void ProcessExtSnapImageL ( CFbsBitmap &)
void ProcessExtViewFinderFrameReadyL ( CFbsBitmap &)
void Release ()
TTimeIntervalMicroSeconds RemainingVideoRecordingTime ()
void Reserve ()
void ResetToDefaultsL ()
void ResumeVideoRecording ()
TInt SetAsyncVideoStopMode ( TBool )
void SetBrightnessL ( TInt )
void SetCaeExtensionModeL ( TBool , TBool )
void SetCaeStillBurstObserver ( MCaeStillBurstObserver &)
void SetCamAppEngineObserver ( MCamAppEngineObserver &)
void SetContrastL ( TInt )
void SetEvCompensationL ( TInt )
void SetExposureModeL ( CCamera::TExposure )
void SetFlashModeL ( CCamera::TFlash )
void SetImageCodecsL ( TUid , TUid )
void SetJpegQuality ( TInt )
void SetOrderL (const RCaeOrderedFeatureList &)
void SetSkippedExtensionList ( RCaeOrderedFeatureList &)
void SetSnapImageColorMode ( TDisplayMode )
void SetSnapImageCreation ( TBool )
void SetSnapImageSizeL ( TSize &)
void SetSnapImageSourceL ( TSnapImageSource )
void SetStillBurstCaptureIntervalL ( TTimeIntervalMicroSeconds )
TInt SetStillCaptureImageCountL ( TInt )
void SetVideoAudioL ( TBool )
void SetVideoClipMaxSizeL ( TInt )
void SetVideoRecordingFileNameL (const TDesC &)
void SetVideoTimesIntervalL ( TTimeIntervalMicroSeconds )
void SetViewFinderMirrorL ( TBool )
void SetWhiteBalanceModeL ( CCamera::TWhiteBalance )
void SetZoomModeL ( TZoomMode )
void SetZoomValueL ( TInt )
void SkippedExtensionListL ( RCaeOrderedFeatureList &)
void StartVideoRecording ()
void StartViewFinderBitmapsL ( TSize &)
void StartViewFinderBitmapsL ( TSize &, TRect &)
void StartViewFinderDirectL (RWsSession &, CWsScreenDevice &, RWindowBase &, TRect &)
void StartViewFinderDirectL (RWsSession &, CWsScreenDevice &, RWindowBase &, TRect &, TRect &)
TTimeIntervalMicroSeconds StillBurstCaptureInterval ()
TInt StillCaptureImageCount ()
TInt StillQualityIndex ()
void StopStillBurstCapture ()
void StopVideoRecording ()
void StopViewFinder ()
TBool VideoAudio ()
TInt VideoClipMaxSize ()
TReal32 VideoFrameRate ( TInt )
TInt VideoQualityIndex ()
TTimeIntervalMicroSeconds VideoTimesInterval ()
TBool ViewFinderMirror ()
CCamera::TWhiteBalance WhiteBalanceMode ()
TZoomMode ZoomMode ()
TInt ZoomValue ()
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()
Public Member Enumerations
enum TOperationMode { EOperationModeStill  = 0x00, EOperationModeVideo  = 0x01 }
enum TSnapImageSource { ESnapImageSourceOriginal , ESnapImageSourceThumbnail }
enum TViewFinder { EViewFinderBitmaps  = 0x00, EViewFinderDirect  = 0x01 }
enum TZoomMode { EZoomModeDigital  = 0x00, EZoomModeOptical  = 0x01, EZoomModeOpticalDigital  = 0x02 }

Member Functions Documentation

Brightness()

TInt Brightness ( ) const [pure virtual]
Gets the current brightness setting.
Since
2.1

CCameraHandle()

TInt CCameraHandle ( ) const [pure virtual]
Gets the device-unique handle of camera object owned by the CCaeEngine .
Since
3.2

CamerasAvailable()

IMPORT_C TInt CamerasAvailable ( ) [static]
Gets the number of cameras on the device.
Since
2.6

CancelCaptureStill()

void CancelCaptureStill ( ) [pure virtual]
Cancels the on-going still image (single/burst) capture request.
Since
2.1

CaptureStill()

void CaptureStill ( ) [pure virtual]
Captures a still image or a still image burst. Calls first observer method McaeoSnapImageReady() and then McaeoStillImageReady(). McaeoSnapImageReady() is not called if engine initialization has been done with parameter aCreateSnapImage == EFalse.
Since
2.1

CloseVideoRecording()

void CloseVideoRecording ( ) [pure virtual]
Closes (prepared) video recording to free resources.
Since
2.1

Contrast()

TInt Contrast ( ) const [pure virtual]
Gets the current contrast setting.
Since
2.1

CustomInterface(TUid)

TAny * CustomInterface ( TUid aInterface ) [pure virtual]
Gets a custom interface. The client has to cast the returned pointer.
Since
2.6

Parameters

TUid aInterface

DisableVideoRecording()

void DisableVideoRecording ( ) [pure virtual]
Set CamAppEngine internal camera state to released and power state off.
Since
3.2

EnableVideoRecording()

void EnableVideoRecording ( ) [pure virtual]
Set CamAppEngine internal camera state to reserved and power state on. This method is used when client uses Camera-API directly through the duplicate instance in still mode, but wants to use CAE in video recording mode without using the CAE InitL.
Since
3.2

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

void EnumerateStillCaptureSizes ( TSize & aSize,
TInt aSizeIndex,
CCamera::TFormat aFormat
) const [pure virtual]
Enumerates through the available image capture sizes. Returns the image size based on the specified size index and format. The largest image resolution is returned for index 0, the smallest for index TCamAppEngineInfo::iNumImageSizesSupported -1. The size index must be in the range 0 to TCamAppEngineInfo::iNumImageSizesSupported -1 inclusive.
Since
2.6

Parameters

TSize & aSize Returned image size.
TInt aSizeIndex Size index.
CCamera::TFormat aFormat The image format.

EnumerateVideoFrameSizeL(const TSize &)

TInt EnumerateVideoFrameSizeL ( const TSize & aSize ) [pure virtual]
Enumerate Video Frame Size.
Since
3.2

Parameters

const TSize & aSize enumerated size

EstimatedStillSizeInBytes(TInt)

TInt EstimatedStillSizeInBytes ( TInt aStillQualityIndex ) const [pure virtual]
Gets the estimated still image size in bytes for the specified quality level.
Since
2.1

Parameters

TInt aStillQualityIndex Still capture quality index.

EstimatedVideoRecordingBitRateL(TInt)

TInt EstimatedVideoRecordingBitRateL ( TInt aVideoQualityIndex ) const [pure virtual]
Gets the estimated video recording bit rate including audio bit rate for the specified video quality level.
Since
2.1

Parameters

TInt aVideoQualityIndex Video quality level index.

EvCompensation()

TInt EvCompensation ( ) const [pure virtual]
Gets the current exposure value (EV) compensation index.
Since
2.1

ExposureMode()

CCamera::TExposure ExposureMode ( ) const [pure virtual]
Gets the current exposure mode.
Since
2.1

FlashMode()

CCamera::TFlash FlashMode ( ) const [pure virtual]
Gets the current flash mode.
Since
2.1

GetInfo(TCamAppEngineInfo &)

void GetInfo ( TCamAppEngineInfo & aInfo ) const [pure virtual]
Gets information about the supported Camera Application Engine and Camera features.
Since
2.1

Parameters

TCamAppEngineInfo & aInfo Info about supported features.

GetOrderL(RCaeOrderedFeatureList &)

void GetOrderL ( RCaeOrderedFeatureList & aOrderedFeatureList ) [pure virtual]
Gets array of features per interfaces. Each feature is ordered in the current calling order e.g. when certain image prosessing operation is applied to the captured image. If SetOrder() has not yet been called, the returned order is the default order.
Since
2.8

Parameters

RCaeOrderedFeatureList & aOrderedFeatureList

GetStillFrameSize(TInt, TSize &)

void GetStillFrameSize ( TInt aStillQualityIndex,
TSize & aSize
) const [pure virtual]
Gets the still image frame size for the specified quality level.
Since
2.1

Parameters

TInt aStillQualityIndex Still capture quality index.
TSize & aSize Still image frame size.

GetVideoFrameSize(TInt, TSize &)

void GetVideoFrameSize ( TInt aVideoQualityIndex,
TSize & aSize
) const [pure virtual]
Gets the video frame size for the specified video quality level.
Since
2.1

Parameters

TInt aVideoQualityIndex Video quality level index.
TSize & aSize

GetViewFinderSize(TSize &)

void GetViewFinderSize ( TSize & aSize ) [pure virtual]
Gets the current view finder size.
Since
2.1

Parameters

TSize & aSize View finder size.

InitL(TBool)

void InitL ( TBool aCreateSnapImage = ETrue ) [pure virtual]
Initializes Camera Application Engine for still image capturing. Reserves the camera and switches the camera power on. Intialization must be done before all other operations, except SetCamAppEngineObserver and GetInfo. Calls observer method McaeoInitComplete().
Since
2.1

Parameters

TBool aCreateSnapImage = ETrue Boolean indicating if "snap-images" should be created, leading to calls of McaeoSnapImageReady.

InitL(TUid, TBool)

void InitL ( TUid aSdUidStillQltyLevels,
TBool aCreateSnapImage = ETrue
) [pure virtual]
Initialize the engine for still image capturing. Switches also camera power on. Intialization must be done before all other operations, except SetCamAppEngineObserver and GetInfo. Calls observer method McaeoInitComplete().
Since
2.1

Parameters

TUid aSdUidStillQltyLevels Still capturing quality levels Shared Data initialization file UID.
TBool aCreateSnapImage = ETrue Boolean indicating if "snap-images" should be created leading to calls of McaeoSnapImageReady.

InitVideoRecorderL()

void InitVideoRecorderL ( ) [pure virtual]
Initializes video recording. The initialization must be done before video recording operations.
Since
2.1

InitVideoRecorderL(TUid)

void InitVideoRecorderL ( TUid aSdUidVideoQltyLevels ) [pure virtual]
Initializes video recording. The initialization must be done before video recording operations.
Since
2.1

Parameters

TUid aSdUidVideoQltyLevels Video recording quality levels Shared Data initialization file UID.

IsVideoRecording()

TBool IsVideoRecording ( ) const [pure virtual]
Queries if video recording is running.
Since
2.1

IsViewFinding()

TBool IsViewFinding ( ) const [pure virtual]
Queries if view finder is running.
Since
2.1

JpegQuality()

TInt JpegQuality ( ) const [pure virtual]
Gets the currently set JPEG quality value. Returns 0 if not previously prepared or set.
Since
2.6

NewL()

IMPORT_C CCaeEngine * NewL ( ) [static]
A static (factory) function to create the class instance.
Since
2.1

NewL(TInt)

IMPORT_C CCaeEngine * NewL ( TInt aCameraIndex ) [static]
A static (factory) function to create the class instance.
Since
2.6

Parameters

TInt aCameraIndex Index from 0 to CamerasAvailable()-1 inclusive specifying the camera device to use.

NewL(TInt, TInt)

IMPORT_C CCaeEngine * NewL ( TInt aCameraIndex,
TInt aDisplayIndex
) [static]
A static (factory) function to create the class instance.
Since
2.6

Parameters

TInt aCameraIndex Index from 0 to CamerasAvailable()-1 inclusive specifying the camera device to use.
TInt aDisplayIndex Display index specifying the display to use.

PauseVideoRecording()

void PauseVideoRecording ( ) [pure virtual]
Pauses video recording. Calls observer method McaeoVideoRecordingPaused().
Since
2.1

PowerOff()

void PowerOff ( ) [pure virtual]
Switches the camera power off.
Since
2.1

PowerOn()

void PowerOn ( ) [pure virtual]
Switches the camera power on. Calls observer method McaeoInitComplete().
Since
2.1

PrepareStillCaptureL(TInt)

void PrepareStillCaptureL ( TInt aStillQualityIndex ) [pure virtual]
Prepares Camera Application Engine for still image capture on specified quality level. Calls observer method McaeoStillPrepareComplete().
Since
2.1

Parameters

TInt aStillQualityIndex Still image quality level index. Imaging parameters linked to quality levels are defined by Shared Data ini-file.

PrepareStillCaptureL(TInt, const TRect &)

void PrepareStillCaptureL ( TInt aStillQualityIndex,
const TRect & aCropRect
) [pure virtual]
Prepares Camera Application Engine for still image capture on specified quality level. Calls observer method McaeoStillPrepareComplete().
Since
2.1

Parameters

TInt aStillQualityIndex Still image quality level index. Can have values 0 ... TCamAppEngineInfo::iNumStillQualityLevelsSupported - 1
const TRect & aCropRect Desired cropping/clipping rectangle.

PrepareStillCaptureL(const TSize &, CCamera::TFormat, TInt)

void PrepareStillCaptureL ( const TSize & aSize,
CCamera::TFormat aFormat,
TInt aCompressionQuality
) [pure virtual]
Prepares Camera Application Engine for still image capture with specified image size and format. Calls observer method McaeoStillPrepareComplete().
Since
2.1

Parameters

const TSize & aSize Still image size.
CCamera::TFormat aFormat Still image format.
TInt aCompressionQuality Still image compression quality [0...100].

PrepareStillCaptureL(const TSize &, CCamera::TFormat, TInt, const TRect &)

void PrepareStillCaptureL ( const TSize & aSize,
CCamera::TFormat aFormat,
TInt aCompressionQuality,
const TRect & aCropRect
) [pure virtual]
Prepares Camera Application Engine for still image capture with specified image size and format. Calls observer method McaeoStillPrepareComplete().
Since
2.1

Parameters

const TSize & aSize Still image size.
CCamera::TFormat aFormat Still image format.
TInt aCompressionQuality Still image compression quality [0...100].
const TRect & aCropRect Desired cropping/clipping rectangle.

PrepareStillCaptureL(TInt, TSize &)

void PrepareStillCaptureL ( TInt aStillQualityIndex,
TSize & aSnapSize
) [pure virtual]
Prepare Camera Application Engine for still image capture on specified quality level with desired snap image size. The returned snap image size is always equal or bigger in both dimensions than the given size. The returned size is stepwise downscaled from the captured image size. The parameter aSnapSize is ignored if the image format does not support it in the engine. Calls observer method McaeoStillPrepareComplete().
Since
2.1

Parameters

TInt aStillQualityIndex Still image quality level index. Can have values 0 ... TCamAppEngineInfo::iNumStillQualityLevelsSupported - 1
TSize & aSnapSize Desired snap image size. Returns the real snap image size.

PrepareStillCaptureL(const TSize &, CCamera::TFormat, TInt, const TRect &, TSize &)

void PrepareStillCaptureL ( const TSize & aSize,
CCamera::TFormat aFormat,
TInt aCompressionQuality,
const TRect & aCropRect,
TSize & aSnapSize
) [pure virtual]
Prepare Camera Application Engine for still image capture with specified image size, format, and desired snap image size. The returned snap image size is always equal or bigger in both dimensions than the given size. The returned size is stepwise downscaled from the captured image size. The parameter aSnapSize is ignored if the image format does not support it in the engine. Calls observer method McaeoStillPrepareComplete().
Since
2.1

Parameters

const TSize & aSize Still image size.
CCamera::TFormat aFormat Still image format.
TInt aCompressionQuality Still image compression quality [0...100].
const TRect & aCropRect Desired cropping/clipping rectangle. The size (0,0) means that this parameter is ignored.
TSize & aSnapSize Desired snap image size. Returns the real snap image size.

PrepareVideoRecordingL(TInt)

void PrepareVideoRecordingL ( TInt aVideoQualityIndex ) [pure virtual]
Prepares Camera Application Engine for video recording on specified quality level. Calls observer method McaeoVideoPrepareComplete().
Since
2.1

Parameters

TInt aVideoQualityIndex Video quality level index. Can have values 0 ... TCamAppEngineInfo::iNumVideoQualityLevelsSupported - 1

PrepareVideoRecordingL(const TSize &, TReal32, TInt, TBool, const TDesC8 &, const TDesC &, const TDesC8 &, const TDesC8 &)

void PrepareVideoRecordingL ( const TSize & aFrameSize,
TReal32 aFrameRate,
TInt aBitRate,
TBool aAudioEnabled,
const TDesC8 & aMimeType,
const TDesC & aPreferredSupplier,
const TDesC8 & aVideoType =  KNullDesC8 ,
const TDesC8 & aAudioType =  KNullDesC8
) [pure virtual]
Prepares Camera Application Engine for video recording with specified recording parameters. Calls observer method McaeoVideoPrepareComplete().
Since
2.1

Parameters

const TSize & aFrameSize Frame size.
TReal32 aFrameRate Frame rate.
TInt aBitRate Bit rate.
TBool aAudioEnabled Boolean indicating whether audio should be enabled or not.
const TDesC8 & aMimeType MIME type.
const TDesC & aPreferredSupplier Preferred supplier of video encoder.
const TDesC8 & aVideoType =  KNullDesC8 Video type.
const TDesC8 & aAudioType =  KNullDesC8 Audio type.

PrepareVideoRecordingL(const TSize &, TReal32, TInt, TBool, TInt, const TDesC8 &, const TDesC &, const TDesC8 &, const TDesC8 &)

void PrepareVideoRecordingL ( const TSize & aFrameSize,
TReal32 aFrameRate,
TInt aBitRate,
TBool aAudioEnabled,
TInt aAudioBitRate,
const TDesC8 & aMimeType,
const TDesC & aPreferredSupplier,
const TDesC8 & aVideoType,
const TDesC8 & aAudioType
) [pure virtual]
Prepares Camera Application Engine for video recording with specified recording parameters. Calls observer method McaeoVideoPrepareComplete().
Since
2.1

Parameters

const TSize & aFrameSize Frame size.
TReal32 aFrameRate Frame rate.
TInt aBitRate Bit rate.
TBool aAudioEnabled Boolean indicating whether audio should be enabled or not.
TInt aAudioBitRate Audio bit rate.
const TDesC8 & aMimeType MIME type.
const TDesC & aPreferredSupplier Preferred supplier of video encoder.
const TDesC8 & aVideoType Video type.
const TDesC8 & aAudioType Audio type.

ProcessExtCancel()

void ProcessExtCancel ( ) [pure virtual]
Cancels extensions processing
Since
3.2

ProcessExtCapturedImageL(CFbsBitmap &, TBool)

void ProcessExtCapturedImageL ( CFbsBitmap & aBitmap,
TBool aLastImage
) [pure virtual]
Process extension for captured image.
Since
3.2

Parameters

CFbsBitmap & aBitmap The captured bitmap image. Does not transfer ownership.
TBool aLastImage Set when last image of the burst is completed.

ProcessExtCapturedImageL(HBufC8 *, TBool)

void ProcessExtCapturedImageL ( HBufC8 * aImageData,
TBool aLastImage
) [pure virtual]
Process extension for captured image.
Since
3.2

Parameters

HBufC8 * aImageData The captured image, if it is a formatted image and type of HBufC8. Ownership is transferred.
TBool aLastImage Set when last image of the burst is completed.

ProcessExtCapturedImageL(TDesC8 &, TBool)

void ProcessExtCapturedImageL ( TDesC8 & aImageDataDes,
TBool aLastImage
) [pure virtual]
Process extension for captured image.
Since
3.2

Parameters

TDesC8 & aImageDataDes The captured image, if it is a formatted image and type of TDesC8. Does not transfer ownership.
TBool aLastImage Set when last image of the burst is completed.

ProcessExtSnapImageL(CFbsBitmap &)

void ProcessExtSnapImageL ( CFbsBitmap & aSnapImage ) [pure virtual]
Process extension for snap image.
Since
3.2

Parameters

CFbsBitmap & aSnapImage The bitmap of snap image. Does not transfer ownership.

ProcessExtViewFinderFrameReadyL(CFbsBitmap &)

void ProcessExtViewFinderFrameReadyL ( CFbsBitmap & aFrame ) [pure virtual]
Process extension for view finder.
Since
3.2

Parameters

CFbsBitmap & aFrame The view finder frame bitmap that is processed.

Release()

void Release ( ) [pure virtual]
Switches the camera power off and releases the camera.
Since
2.1

RemainingVideoRecordingTime()

TTimeIntervalMicroSeconds RemainingVideoRecordingTime ( ) const [pure virtual]
Gets the remaining video recording time before recording has started.
Since
2.1

Reserve()

void Reserve ( ) [pure virtual]
Reserves the camera into use and switches the camera power on. Calls observer method McaeoInitComplete().
Since
2.1

ResetToDefaultsL()

void ResetToDefaultsL ( ) [pure virtual]
Resets to the default setting values. Resets the following settings: exposure mode, white balance mode, zoom mode, zoom value, flash mode, brightness, and contrast.
Since
2.1

ResumeVideoRecording()

void ResumeVideoRecording ( ) [pure virtual]
Resumes video recording after pause. Calls observer method McaeoVideoRecordingOn().
Since
2.1

SetAsyncVideoStopMode(TBool)

TInt SetAsyncVideoStopMode ( TBool aAsyncVideoStopEnabled ) [pure virtual]
Set asynchronous video recording stop mode. When Enabled then StopVideoRecording will return quickly and MCamAppEngineObserver callbacks McaeoVideoRecordingStopped and McaeoVideoRecordingComplete are called asynchronously.
Since
5.0

Parameters

TBool aAsyncVideoStopEnabled The async stop state.

SetBrightnessL(TInt)

void SetBrightnessL ( TInt aBrightness = 0 ) [pure virtual]
Sets the brightness.
Since
2.1

Parameters

TInt aBrightness = 0 Brightness value in the range ECam.h SetBrightnessL allows.

SetCaeExtensionModeL(TBool, TBool)

void SetCaeExtensionModeL ( TBool aExtModeActive,
TBool aCreateSnapImage
) [pure virtual]
Sets CAE to Extension processing mode.
Since
3.2

Parameters

TBool aExtModeActive Boolean indicating if extension mode is enabled or disabled.
TBool aCreateSnapImage Boolean indicating if "snap-images" should be created by CAE.

SetCaeStillBurstObserver(MCaeStillBurstObserver &)

void SetCaeStillBurstObserver ( MCaeStillBurstObserver & aObserver ) [pure virtual]
Sets the Camera Application Engine still image burst capturing observer.
Since
2.1

Parameters

MCaeStillBurstObserver & aObserver Camera Application Engine still burst observer.

SetCamAppEngineObserver(MCamAppEngineObserver &)

void SetCamAppEngineObserver ( MCamAppEngineObserver & aObserver ) [pure virtual]
Sets the Camera Application Engine observer.
Since
2.1

Parameters

MCamAppEngineObserver & aObserver Reference to Camera Application Engine observer.

SetContrastL(TInt)

void SetContrastL ( TInt aContrast = 0 ) [pure virtual]
Sets the contrast.
Since
2.1

Parameters

TInt aContrast = 0 Contrast value in the range ECam.h SetContrastL allows.

SetEvCompensationL(TInt)

void SetEvCompensationL ( TInt aEvIndex = 0 ) [pure virtual]
Sets the exposure value (EV) compensation index.
Since
2.1

Parameters

TInt aEvIndex = 0 Exposure value compensation index to set.

SetExposureModeL(CCamera::TExposure)

void SetExposureModeL ( CCamera::TExposure aExposureMode = CCamera::EExposureAuto ) [pure virtual]
Sets the exposure mode.
Since
2.1

Parameters

CCamera::TExposure aExposureMode = CCamera::EExposureAuto Exposure mode in the range ECam.h SetExposureL allows.

SetFlashModeL(CCamera::TFlash)

void SetFlashModeL ( CCamera::TFlash aFlashMode = CCamera::EFlashNone ) [pure virtual]
Sets the flash mode.
Since
2.1

Parameters

CCamera::TFlash aFlashMode = CCamera::EFlashNone Flash mode in the range ECam.h SetFlashL allows.

SetImageCodecsL(TUid, TUid)

void SetImageCodecsL ( TUid aDecoderUid,
TUid aEncoderUid
) [pure virtual]
Sets the specific image codec implementation to be used in decoding and encoding.
Since
3.1

Parameters

TUid aDecoderUid The UID of the specific image decoder to be used. KNullUid means the default decoder.
TUid aEncoderUid The UID of the specific image encoder to be used. KNullUid means the default encoder.

SetJpegQuality(TInt)

void SetJpegQuality ( TInt aQuality ) [pure virtual]
Sets the quality value to use with JPEG and Exif image formats.
Since
2.6

Parameters

TInt aQuality The quality value to use, clamped to the range 1 to 100.

SetOrderL(const RCaeOrderedFeatureList &)

void SetOrderL ( const RCaeOrderedFeatureList & aOrderedFeatureList ) [pure virtual]
Sets array of features per interfaces. Each feature should be ordered according to the wanted calling order e.g. to define when certain image prosessing operation is applied to the captured image. If this method leaves, the internal array has not been changed.
Since
2.8

Parameters

const RCaeOrderedFeatureList & aOrderedFeatureList

SetSkippedExtensionList(RCaeOrderedFeatureList &)

void SetSkippedExtensionList ( RCaeOrderedFeatureList & aSkippedExtensions ) [pure virtual]
Set list of skipped extensions. Application may define which extensions are skipped during image processing. The GetOrderL() returns the list of all installed extensions.
Since
3.2

Parameters

RCaeOrderedFeatureList & aSkippedExtensions The list of installed and skipped extensions TUid.

SetSnapImageColorMode(TDisplayMode)

void SetSnapImageColorMode ( TDisplayMode aMode ) [pure virtual]
Sets the color mode of the snap image bitmap
Since
2.8

Parameters

TDisplayMode aMode The color mode of the snap bitmap.

SetSnapImageCreation(TBool)

void SetSnapImageCreation ( TBool aCreateSnapImage = ETrue ) [pure virtual]
Sets snap image creation on/off.
Since
2.1

Parameters

TBool aCreateSnapImage = ETrue Boolean indicating if "snap-images" for displaying should be created, leading to calls of McaeoSnapImageReady.

SetSnapImageSizeL(TSize &)

void SetSnapImageSizeL ( TSize & aSize ) [pure virtual]
Sets the size of the snap image bitmap.
Since
2.8

Parameters

TSize & aSize The size of the snap bitmap. Corrected size is returned.

SetSnapImageSourceL(TSnapImageSource)

void SetSnapImageSourceL ( TSnapImageSource aSnapImageSource ) [pure virtual]
Sets the source of the snap image bitmap.
Since
2.8

Parameters

TSnapImageSource aSnapImageSource The source of the snap image bitmap.

SetStillBurstCaptureIntervalL(TTimeIntervalMicroSeconds)

void SetStillBurstCaptureIntervalL ( TTimeIntervalMicroSeconds aInterval ) [pure virtual]
Sets the time interval between single captures in still burst.
Since
2.1

Parameters

TTimeIntervalMicroSeconds aInterval Time interval in microseconds.

SetStillCaptureImageCountL(TInt)

TInt SetStillCaptureImageCountL ( TInt aImageCount ) [pure virtual]
Sets the image count for still image (burst) capturing. Note: Inputting value 1 switches back to normal still capturing.
Since
2.1

Parameters

TInt aImageCount The desired count of images to capture (in a burst).

SetVideoAudioL(TBool)

void SetVideoAudioL ( TBool aAudioEnabled ) [pure virtual]
Sets audio enabled or disabled for video recording.
Since
2.1

Parameters

TBool aAudioEnabled Boolean indicating whether audio should be enabled or not for video recording.

SetVideoClipMaxSizeL(TInt)

void SetVideoClipMaxSizeL ( TInt aMaxClipSizeInBytes = 0 ) [pure virtual]
Sets the maximum size in bytes for a video clip.
Since
2.1

Parameters

TInt aMaxClipSizeInBytes = 0 Maximum video clip size measured in bytes. If set to 0, then no limit but the available storage space.

SetVideoRecordingFileNameL(const TDesC &)

void SetVideoRecordingFileNameL ( const TDesC & aVideoClipFileName ) [pure virtual]
Sets the file name for the video clip to be recorded.
Since
2.1

Parameters

const TDesC & aVideoClipFileName File name.

SetVideoTimesIntervalL(TTimeIntervalMicroSeconds)

void SetVideoTimesIntervalL ( TTimeIntervalMicroSeconds aInterval ) [pure virtual]
Sets the time interval for video recording time info.
Since
2.1

Parameters

TTimeIntervalMicroSeconds aInterval Time interval in microseconds for video recording time info. If zero is given as interval, then video recording time is not generated.

SetViewFinderMirrorL(TBool)

void SetViewFinderMirrorL ( TBool aMirror = EFalse ) [pure virtual]
Sets/resets view finder image mirroring.
Since
2.1

Parameters

TBool aMirror = EFalse Boolean indicating whether view finder image should be mirrored or not.

SetWhiteBalanceModeL(CCamera::TWhiteBalance)

void SetWhiteBalanceModeL ( CCamera::TWhiteBalance aWhiteBalanceMode = CCamera::EWBAuto ) [pure virtual]
Sets the white balance mode.
Since
2.1

Parameters

CCamera::TWhiteBalance aWhiteBalanceMode = CCamera::EWBAuto White balance mode in the range ECam.h SetWhiteBalanceL allows.

SetZoomModeL(TZoomMode)

void SetZoomModeL ( TZoomMode aZoomMode = EZoomModeDigital ) [pure virtual]
Sets the zoom mode.
Since
2.1

Parameters

TZoomMode aZoomMode = EZoomModeDigital Zoom mode to set.

SetZoomValueL(TInt)

void SetZoomValueL ( TInt aZoomValue = 0 ) [pure virtual]
Sets the zoom value.
Since
2.1

Parameters

TInt aZoomValue = 0 Index of the zoom factor to set.

SkippedExtensionListL(RCaeOrderedFeatureList &)

void SkippedExtensionListL ( RCaeOrderedFeatureList & aSkippedExtensions ) [pure virtual]
Get list of skipped extensions. Application may define which extensions are skipped during image processing.
Since
3.2

Parameters

RCaeOrderedFeatureList & aSkippedExtensions The list of skipped extensions TUid.

StartVideoRecording()

void StartVideoRecording ( ) [pure virtual]
Starts video recording. Calls observer method McaeoVideoRecordingOn().
Since
2.1

StartViewFinderBitmapsL(TSize &)

void StartViewFinderBitmapsL ( TSize & aSize ) [pure virtual]
Starts the bitmap-based view finder. The engine starts to call observer method McaeoViewFinderFrameReady() repeatedly.
Since
2.1

Parameters

TSize & aSize Desired view finder size.

StartViewFinderBitmapsL(TSize &, TRect &)

void StartViewFinderBitmapsL ( TSize & aSize,
TRect & aCropRect
) [pure virtual]
Starts the bitmap-based view finder. The engine starts to call observer method McaeoViewFinderFrameReady() repeatedly.
Since
2.1

Parameters

TSize & aSize Desired view finder size.
TRect & aCropRect Desired cropping/clipping rectangle.

StartViewFinderDirectL(RWsSession &, CWsScreenDevice &, RWindowBase &, TRect &)

void StartViewFinderDirectL ( RWsSession & aWs,
CWsScreenDevice & aScreenDevice,
RWindowBase & aWindow,
TRect & aScreenRect
) [pure virtual]
Starts the direct screen access view finder.
Since
2.1

Parameters

RWsSession & aWs Window server session.
CWsScreenDevice & aScreenDevice Software device screen.
RWindowBase & aWindow Client-side handle to a server-side window.
TRect & aScreenRect Portion of screen in screen co-ordinates.

StartViewFinderDirectL(RWsSession &, CWsScreenDevice &, RWindowBase &, TRect &, TRect &)

void StartViewFinderDirectL ( RWsSession & aWs,
CWsScreenDevice & aScreenDevice,
RWindowBase & aWindow,
TRect & aScreenRect,
TRect & aCropRect
) [pure virtual]
Starts the direct screen access view finder.
Since
2.1

Parameters

RWsSession & aWs Window server session.
CWsScreenDevice & aScreenDevice Software device screen.
RWindowBase & aWindow Client-side handle to a server-side window.
TRect & aScreenRect Portion of screen in screen co-ordinates.
TRect & aCropRect Desired cropping/clipping rectangle.

StillBurstCaptureInterval()

TTimeIntervalMicroSeconds StillBurstCaptureInterval ( ) const [pure virtual]
Gets the time interval between single captures in still burst.
Since
2.1

StillCaptureImageCount()

TInt StillCaptureImageCount ( ) const [pure virtual]
Gets the image count for still image (burst) capturing.
Since
2.1

StillQualityIndex()

TInt StillQualityIndex ( ) const [pure virtual]
Gets the current prepared still quality level index.
Since
2.1

StopStillBurstCapture()

void StopStillBurstCapture ( ) [pure virtual]
Stops still image burst capturing. Delivers the burst images captured before call. This is different from CancelCaptureStill that cancels the operation and prevents delivering the captured image.
Since
2.1

StopVideoRecording()

void StopVideoRecording ( ) [pure virtual]
Stops video recording. Calls observer method McaeoVideoRecordingComplete().
Since
2.1

StopViewFinder()

void StopViewFinder ( ) [pure virtual]
Stops the view finder.
Since
2.1

VideoAudio()

TBool VideoAudio ( ) const [pure virtual]
Queries if audio is enabled or disabled for video recording.
Since
2.1

VideoClipMaxSize()

TInt VideoClipMaxSize ( ) const [pure virtual]
Gets the current maximum size in bytes for a video clip.
Since
2.1

VideoFrameRate(TInt)

TReal32 VideoFrameRate ( TInt aVideoQualityIndex ) const [pure virtual]
Gets the video frame rate for the specified video quality level.
Since
2.1

Parameters

TInt aVideoQualityIndex Video quality level index.

VideoQualityIndex()

TInt VideoQualityIndex ( ) const [pure virtual]
Gets the current prepared video quality level index.
Since
2.1

VideoTimesInterval()

TTimeIntervalMicroSeconds VideoTimesInterval ( ) const [pure virtual]
Gets the current time interval for video recording time info.
Since
2.1

ViewFinderMirror()

TBool ViewFinderMirror ( ) const [pure virtual]
Queries if view finder image mirroring is on.
Since
2.1

WhiteBalanceMode()

CCamera::TWhiteBalance WhiteBalanceMode ( ) const [pure virtual]
Gets the current white balance mode.
Since
2.1

ZoomMode()

TZoomMode ZoomMode ( ) const [pure virtual]
Gets the current zoom mode.
Since
2.1

ZoomValue()

TInt ZoomValue ( ) const [pure virtual]
Gets the current zoom value.
Since
2.1

Member Enumerations Documentation

Enum TOperationMode

Enumerators

EOperationModeStill = 0x00
EOperationModeVideo = 0x01

Enum TSnapImageSource

Enumerators

ESnapImageSourceOriginal
ESnapImageSourceThumbnail

Enum TViewFinder

Enumerators

EViewFinderBitmaps = 0x00
EViewFinderDirect = 0x01

Enum TZoomMode

Enumerators

EZoomModeDigital = 0x00
EZoomModeOptical = 0x01
EZoomModeOpticalDigital = 0x02

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.