CCamera::CCameraAdvancedSettings Class Reference

#include <ecamadvsettings.h>

Link against: ecamadvsettings.lib

class CCamera::CCameraAdvancedSettings : public CBase

Inherits from

CCamera::CCameraAdvancedSettings

Nested Classes and Structures

Public Member Enumerations
enum	TAFAssistantLight { EAFAssistantLightOff, EAFAssistantLightManualOn, EAFAssistantLightAuto }
enum	TAutoFocusArea { EAutoFocusTypeAuto, EAutoFocusTypeSingleArea, EAutoFocusTypeMultiAreaCentered }
enum	TAutoFocusType { EAutoFocusTypeOff, EAutoFocusTypeSingle, EAutoFocusTypeContinuous }
enum	TBracketMode { EBracketModeOff, EBracketMode3Image, EBracketMode5Image }
enum	TBracketParameter { EBracketParameterNone, EBracketParameterExposure, EBracketParameterFlashPower, EBracketParameterColourBalance, ..., BracketParameterAutoFocus }
enum	TBracketStep { EBracketStepNonConfig, EBracketStepSmall, EBracketStepMedium, EBracketStepLarge }
enum	TCameraMode { EModeIdle, EModeDSAViewFinder, EModeClientViewFinder }
enum	TCameraType { ECameraUnknown, ECameraOnBoard, ECameraPluggable }
enum	TColorChannel { EColorChannelRed, EColorChannelGreen, EColorChannelBlue, EChannelLumaY, ..., EChannelChromaV }
enum	TContinuousZoomType { EContinuousZoomNotSupported, EContinuousZoomOpticalOnly, EContinuousZoomMixed, EContinuousZoomDigitalOnly }
enum	TDriveMode { EDriveModeAuto, EDriveModeSingleShot, EDriveModeContinuous, EDriveModeBracket, ..., EDriveModeTimeNudgeCapture }
enum	TFlickerRemoval { EFlickerRemovalNone, EFlickerRemoval50Hz, EFlickerRemoval60Hz, EFlickerRemovalAuto, EFlickerRemovalSwitchOff }
enum	TFocusMode { EFocusModeUnknown, EFocusModeAuto, EFocusModeFixed, EFocusModeManual }
enum	TFocusRange { EFocusRangeAuto, EFocusRangeMacro, EFocusRangeNormal, EFocusRangeTele, ..., EFocusRangeInfinite }
enum	TISORateType { EISONone, EISOManual, EISOAutoUnPrioritised, EISOAutoISOPrioritised, ..., EISOAutoAperturePrioritised }
enum	TLEDEffect { ELEDEffectNone, ELEDEffectHardwired, ELEDEffectAuto, ELEDEffectManualSwitchOn, ..., ELEDEffectCustom }
enum	TLEDEvent { ELEDEventNone, ELEDEventSelfTimer, ELEDEventViewfinderStart, ELEDEventViewfinderStop, ..., ELEDEventVideoRecording }
enum	TMeteringMode { EMeteringModeAuto, EMeteringModeCenterWeighted, EMeteringModeSpot, EMeteringModeEvaluative }
enum	TNDFilter { ENDFilterNone, ENDFilterAuto, ENDFilterSwitchedOff, ENDFilterHigh, ..., ENDFilterGeneral }
enum	TPerformanceLevel { ELevelHigh, ELevelMedium, ELevelLow, ELevelDontCare }
enum	TPictureOrientation { EPictureOrientationUnknown, EPictureOrientationPortrait, EPictureOrientationLandscape, EPictureOrientationSquare }
enum	TPixelAspectRatio { EPixelAspectUnknown, EPixelAspect1To1, EPixelAspect12To11, EEPixelAspect11To10, ..., EEPixelAspect40To33 }
enum	TPreCaptureWarning { EPCWNone, EPCWOverExposure, EPCWUnderExposure, EPCWLowLight, ..., EPCWFlashNotNeeded }
enum	TStabilizationAlgorithmComplexity { EStabilizationComplexityAuto, EStabilizationComplexityLow, EStabilizationComplexityMedium, EStabilizationComplexityHigh }
enum	TStabilizationEffect { EStabilizationOff, EStabilizationAuto, EStabilizationFine, EStabilizationMedium, EStabilizationStrong }
enum	TStabilizationMode { EStabilizationModeOff, EStabilizationModeHorizontal, EStabilizationModeVertical, EStabilizationModeRotation, ..., EStabilizationModeManual }
enum	TWBUnits { EWBUnknown, EWBColorTemperature, EWBRgb }
enum	TYuvRange { EYuvRangeUnknown, EYuvRangeFull, EYuvRangeVideoCropped }
enum	TZoomDirection { EZoomDirectionNone, EZoomDirectionWide, EZoomDirectionTele }

Public Member Functions
	~CCameraAdvancedSettings()
IMPORT_C TInt	Aperture()
IMPORT_C TBool	ApertureExposureLockOn()
IMPORT_C TAutoFocusArea	AutoFocusArea()
IMPORT_C TBool	AutoFocusLockOn()
IMPORT_C TAutoFocusType	AutoFocusType()
IMPORT_C TBool	AutomaticSizeSelectionChangeOn()
IMPORT_C TBracketMode	BracketMode()
IMPORT_C TBracketParameter	BracketParameter()
IMPORT_C TBracketStep	BracketStep()
IMPORT_C TInt	BurstImages()
IMPORT_C TInt	CameraIndex()
IMPORT_C TCameraType	CameraType()
IMPORT_C TCameraType	CameraType(TInt)
IMPORT_C TInt	ContinuousAutoFocusTimeout()
IMPORT_C void	CreateContinuousZoomL(MContinuousZoomObserver &, TContinuousZoomType, CCameraContinuousZoom *&)
IMPORT_C TInt	DigitalZoom()
IMPORT_C TDriveMode	DriveMode()
IMPORT_C void	EnumerateOperationPreferenceL(TUint, TPerformanceLevel &, TPerformanceLevel &, TPerformanceLevel &, TPerformanceLevel &)
IMPORT_C TInt	ExposureCompensation()
IMPORT_C TInt	ExposureCompensationStep()
IMPORT_C TBool	ExposureLockOn()
IMPORT_C CCamera::TExposure	ExposureMode()
IMPORT_C TInt	FlashCompensation()
IMPORT_C TInt	FlashCompensationStep()
IMPORT_C CCamera::TFlash	FlashMode()
IMPORT_C TInt	FocusDistance()
IMPORT_C TFocusMode	FocusMode()
IMPORT_C TFocusRange	FocusRange()
IMPORT_C void	GetAFAssistantLightL(TAFAssistantLight &)
IMPORT_C void	GetActiveSettingsL(RArray< TUid > &)
IMPORT_C void	GetAperturesL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetBracketMerge(TInt &, TInt &)
IMPORT_C void	GetCurrentFocusModeStepsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetDigitalZoomStepsForStillL(RArray< TInt > &, TValueInfo &, TInt, CCamera::TFormat, TBool &)
IMPORT_C void	GetDigitalZoomStepsForVideoL(RArray< TInt > &, TValueInfo &, TInt, TInt, CCamera::TFormat, TBool &, CCamera::TExposure)
IMPORT_C void	GetDigitalZoomStepsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetDisabledSettingsL(RArray< TUid > &)
IMPORT_C TInt	GetExposureCompensation(TInt &)
IMPORT_C void	GetExposureCompensationRangeInSteps(TInt &, TInt &)
IMPORT_C TInt	GetExposureCompensationStep(TInt &)
IMPORT_C void	GetExposureCompensationStepsL(RArray< TInt > &, TValueInfo &)
IMPORT_C TInt	GetFlashCompensation(TInt &)
IMPORT_C void	GetFlashCompensationRangeInSteps(TInt &, TInt &)
IMPORT_C TInt	GetFlashCompensationStep(TInt &)
IMPORT_C void	GetFlashCompensationStepsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetFocalLengthInfoL(TInt &, TInt &, TInt &)
IMPORT_C void	GetISORateL(TISORateType &, TInt &, TInt &)
IMPORT_C void	GetIndirectFeatureChangesL(TUid, RArray< TUid > &)
IMPORT_C void	GetManualFlashPowerLevelsL(RArray< TInt > &, TValueInfo &)
IMPORT_C TInt	GetMinFocalLength()
IMPORT_C void	GetNumOperationPreferenceL(TUint &)
IMPORT_C void	GetOperationPreferenceL(TInt &)
IMPORT_C void	GetOpticalZoomStepsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetPreCaptureWarningL(TInt &)
IMPORT_C void	GetPreCaptureWarningSupportedL(TCameraMode, TInt &)
IMPORT_C void	GetShutterSpeedsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetSupportedAFAssistantLightL(TInt &)
IMPORT_C void	GetSupportedContinuousAutoFocusTimeoutsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetSupportedContinuousZoomTypeL(TUint &)
IMPORT_C void	GetSupportedEventsL(RArray< TUid > &)
IMPORT_C void	GetSupportedISORateTypeL(TInt &)
IMPORT_C void	GetSupportedIsoRatesL(RArray< TInt > &)
IMPORT_C void	GetSupportedSettingsL(RArray< TUid > &)
IMPORT_C void	GetTimeLapse(TTime &, TTime &, TTime &)
IMPORT_C void	GetTimeLapsePeriodRange(TTime &, TTime &)
IMPORT_C void	GetTimerIntervalsL(RArray< TInt > &, TValueInfo &)
IMPORT_C void	GetWBRgbValue(TRgb &)
IMPORT_C void	GetWBSupportedColorTemperaturesL(RArray< TInt > &, TValueInfo &)
IMPORT_C TBool	IsCameraPresent()
IMPORT_C TBool	IsCameraPresent(TInt)
IMPORT_C TBool	IsExternalFlashPresent()
IMPORT_C TInt	IsFlashReady(TBool &)
IMPORT_C TInt	IsoRate()
IMPORT_C TInt	ManualFlashPowerLevel()
IMPORT_C TMeteringMode	MeteringMode()
IMPORT_C CCameraAdvancedSettings *	NewL(CCamera &)
IMPORT_C TInt	OpticalZoom()
IMPORT_C TPictureOrientation	PictureOrientation()
IMPORT_C TPixelAspectRatio	PixelAspectRatio()
IMPORT_C TBool	RedEyeReduceOn()
IMPORT_C void	SetAFAssistantLightL(TAFAssistantLight)
IMPORT_C void	SetAperture(TInt)
IMPORT_C void	SetApertureExposureLockOn(TBool)
IMPORT_C void	SetAutoFocusArea(TAutoFocusArea)
IMPORT_C void	SetAutoFocusLockOn(TBool)
IMPORT_C void	SetAutoFocusType(TAutoFocusType)
IMPORT_C void	SetAutomaticSizeSelectionChangeOn(TBool)
IMPORT_C void	SetBracketMerge(TInt, TInt)
IMPORT_C void	SetBracketMode(TBracketMode)
IMPORT_C void	SetBracketParameter(TBracketParameter)
IMPORT_C void	SetBracketStep(TBracketStep)
IMPORT_C void	SetBurstImages(TInt)
IMPORT_C void	SetContinuousAutoFocusTimeout(TInt)
IMPORT_C void	SetDigitalZoom(TInt)
IMPORT_C void	SetDriveMode(TDriveMode)
IMPORT_C void	SetExposureCompensation(TInt)
IMPORT_C void	SetExposureCompensationStep(TInt)
IMPORT_C void	SetExposureLockOn(TBool)
IMPORT_C void	SetExposureMode(CCamera::TExposure)
IMPORT_C void	SetFlashCompensation(TInt)
IMPORT_C void	SetFlashCompensationStep(TInt)
IMPORT_C void	SetFlashMode(CCamera::TFlash)
IMPORT_C void	SetFocusDistance(TInt)
IMPORT_C void	SetFocusMode(TFocusMode)
IMPORT_C void	SetFocusRange(TFocusRange)
IMPORT_C void	SetISORateL(TISORateType, TInt)
IMPORT_C void	SetIsoRate(TInt)
IMPORT_C void	SetManualFlashPowerLevel(TInt)
IMPORT_C void	SetMeteringMode(TMeteringMode)
IMPORT_C void	SetOperationPreferenceL(TUint)
IMPORT_C void	SetOpticalZoom(TInt)
IMPORT_C void	SetPictureOrientation(TPictureOrientation)
IMPORT_C void	SetPixelAspectRatio(TPixelAspectRatio)
IMPORT_C void	SetRedEyeReduceOn(TBool)
IMPORT_C void	SetReferenceScreenL(CWsScreenDevice &)
IMPORT_C void	SetShootClickOn(TBool)
IMPORT_C void	SetShutterSpeed(TInt)
IMPORT_C void	SetStabilizationComplexity(TStabilizationAlgorithmComplexity)
IMPORT_C void	SetStabilizationEffect(TStabilizationEffect)
IMPORT_C void	SetStabilizationMode(TStabilizationMode)
IMPORT_C void	SetTimeLapse(const TTime &, const TTime &, const TTime &)
IMPORT_C void	SetTimerInterval(TInt)
IMPORT_C void	SetWBColorTemperature(TInt)
IMPORT_C void	SetWBRgbValue(const TRgb &)
IMPORT_C void	SetWhiteBalanceMode(CCamera::TWhiteBalance)
IMPORT_C void	SetYuvRange(TYuvRange)
IMPORT_C TBool	ShootClickOn()
IMPORT_C TInt	ShutterSpeed()
IMPORT_C TStabilizationAlgorithmComplexity	StabilizationComplexity()
IMPORT_C TStabilizationEffect	StabilizationEffect()
IMPORT_C TStabilizationMode	StabilizationMode()
IMPORT_C void	SubscribeToPreCaptureWarningL(TInt)
IMPORT_C TInt	SupportedAutoFocusAreas()
IMPORT_C TInt	SupportedAutoFocusTypes()
IMPORT_C TInt	SupportedBracketModes()
IMPORT_C TInt	SupportedBracketParameters()
IMPORT_C TInt	SupportedBracketSteps()
IMPORT_C TInt	SupportedDriveModes()
IMPORT_C TInt	SupportedExposureModes()
IMPORT_C TInt	SupportedFlashModes()
IMPORT_C TInt	SupportedFocusModes()
IMPORT_C TInt	SupportedFocusRanges()
IMPORT_C TInt	SupportedMeteringModes()
IMPORT_C TInt	SupportedPixelAspectRatios()
IMPORT_C TInt	SupportedStabilizationComplexityValues()
IMPORT_C TInt	SupportedStabilizationEffects()
IMPORT_C TInt	SupportedStabilizationModes()
IMPORT_C TWBUnits	SupportedWBUnits()
IMPORT_C TInt	SupportedWhiteBalanceModes()
IMPORT_C TInt	SupportedYuvRanges()
IMPORT_C TInt	TimerInterval()
IMPORT_C void	UnSubscribePreCaptureWarningL()
IMPORT_C TInt	WBColorTemperature()
IMPORT_C CCamera::TWhiteBalance	WhiteBalanceMode()
IMPORT_C TYuvRange	YuvRange()

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

CCamera advanced settings class exposes an API for controlling individually digital camera advanced settings. These settings directly relate to the image acquisition phase both for still images and video.

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.

Member Enumeration Documentation

Enum TAFAssistantLight

Specifies the different types of auto focus assistant light

Enumerator	Value	Description
EAFAssistantLightOff	0x00	switch off the AF assistant light from either of 'manual on' or 'auto' mode
EAFAssistantLightManualOn	0x01	switch on the AF assistant light manually
EAFAssistantLightAuto	0x02	Put the AF assistant light in auto mode. It will be automatically decided when to switch on or off.

Enum TAutoFocusArea

Specifies the autofocus area.

Enumerator	Value	Description
EAutoFocusTypeAuto	0x00	Automatic. Default value
EAutoFocusTypeSingleArea	0x01	Single area, suitable for relatively flat surfaces and portrait.
EAutoFocusTypeMultiAreaCentered	0x02	Multiple points of an object, more weighting for centre points.

Enum TAutoFocusType

Specifies the supported autofocus types.

Enumerator	Value	Description
EAutoFocusTypeOff	0x00	Autofocus is switched off.
EAutoFocusTypeSingle	0x01	Operates on a single shot, consumes less power.
EAutoFocusTypeContinuous	0x02	Continious autofocus, more precise but consumes more power. also known as AF Servo.

Enum TBracketMode

Specifies Bracket mode.

Enumerator	Value	Description
EBracketModeOff	0x0000	Bracket mode is switched off. Default value.
EBracketMode3Image	0x0001	Bracket mode on. Three consecutive pictures are taken in order under (-1), on (0), over (+1), where correction magnitude is defined by bracket step size and by TBracketParameter See also: TBracketStep TBracketParameter
EBracketMode5Image	0x0002	Bracket mode on. Five consecutive pictures are taken in order under (-2),under (-1), on (0), over (+1), over (+2), where correction magnitude is defined by bracket step size and by TBracketParameter See also: TBracketStep TBracketParameter

Enumerator

Value

Description

EBracketModeOff

0x0000

Bracket mode is switched off. Default value.

EBracketMode3Image

0x0001

Bracket mode on. Three consecutive pictures are taken in order under (-1), on (0), over (+1), where correction magnitude is defined by bracket step size and by TBracketParameter

EBracketMode5Image

0x0002

Bracket mode on. Five consecutive pictures are taken in order under (-2),under (-1), on (0), over (+1), over (+2), where correction magnitude is defined by bracket step size and by TBracketParameter

Enum TBracketParameter

Supported parameters used for bracketing.

Note:

Bracket mode parameter value changes by a selected uniform step between successive image shots.

Enumerator	Value	Description
EBracketParameterNone	0x0000	None.
EBracketParameterExposure	0x0001	Exposure settings change.
EBracketParameterFlashPower	0x0002	Flash power change.
EBracketParameterColourBalance	0x0004	Colour balance settings change.
BracketParameterAperture	0x0008	Aperture settings change.
BracketParameterAutoFocus	0x0010	Autofocus settings change.

Enum TBracketStep

Specifies the magnitude of bracketing step. The actual value and availability is parameter dependent.

Enumerator	Value	Description
EBracketStepNonConfig	0x00	Not supported.
EBracketStepSmall	0x01	Small value.
EBracketStepMedium	0x02	Medium value.
EBracketStepLarge	0x04	Large value.

Enum TCameraMode

Describes the camera mode.

Enumerator	Value	Description
EModeIdle	0x00	Camera is Idle
EModeDSAViewFinder	0x01	DSA based Viewfinder runs
EModeClientViewFinder	0x02	Client based Viewfinder runs

Enum TCameraType

Specifies camera type.

Enumerator	Value	Description
ECameraUnknown	0x00	Unable to identify.
ECameraOnBoard	0x01	Camera is non-detachable from device. Camera is always present.
ECameraPluggable	0x02	Camera is detachable from device. Camera is not always present.

Enum TColorChannel

Color channels on which manual gain can be selectively applied. The enumeration list may be extended in future.

Enumerator	Value	Description
EColorChannelRed		Red Color Channel (RGB model).
EColorChannelGreen		Green Color Channel (RGB model).
EColorChannelBlue		Blue Color Channel (RGB model).
EChannelLumaY		Luminance Y component (YUV model).
EChannelChromaU		Chrominance U component (YUV model).
EChannelChromaV		Chrominance V component (YUV model).

Enum TContinuousZoomType

Specifies the different types of continuous zoom supported. The enumeration list may be extended in future.

Enumerator	Value	Description
EContinuousZoomNotSupported	0x00	Continuous zoom not supported
EContinuousZoomOpticalOnly	0x01	Continuous zoom 'Optical' only, No 'Digital'
EContinuousZoomMixed	0x02	Continuous zoom 'Optical' and 'Digital'
EContinuousZoomDigitalOnly	0x04	Continuous zoom 'Digital' only, No 'Optical'

Enum TDriveMode

Specifies the drive mode for the camera. This determines how and in what sucession are images shot. EDriveModeSingleShot is the default.

Enumerator	Value	Description
EDriveModeAuto	0x0000	Automatic. Default
EDriveModeSingleShot	0x0001	Camera takes a single image/shot.
EDriveModeContinuous	0x0002	Camera continuously captures images (as fast as it can) until stopped or out of storage medium.
EDriveModeBracket	0x0004	Camera is in bracketing mode, producing individual frames. See also: TBracketMode
EDriveModeBracketMerge	0x0008	Camera is in bracketing mode, but producing a single image. See also: TBracketMode
EDriveModeTimed	0x0010	camera captures a single shot after specified time period. See also: Timer()
EDriveModeTimeLapse	0x0020	Camera captures a set of images with an uniform interval between them. See also: TimeLapse()
EDriveModeBurst	0x0040	Camera captures a set of images as fast as it can, but in batches(bursts).
EDriveModeTimeNudgeCapture	0x0080	Camera captures a set of images before and after camera capture key press event. Client can specify the amount of pre-capture and post-capture images to be saved via TDriveModeDependentAttributes. The total amount of images to be saved will be pre-capture images + 1 + post-capture images. Note: This drive mode is only available to clients using the CCamera::New2L() or CCamera::NewDuplicate2L() in addition to the new image capture APIs ie. CCameraPreImageCaptureControl, CCameraImageCapture and CCameraPostImageCaptureControl.

Enum TFlickerRemoval

Specifies flicker removal options. The enumeration list may be extended in future.

Enumerator	Value	Description
EFlickerRemovalNone	0x00	Not Supported.
EFlickerRemoval50Hz	0x01	Flicker removal for Field frequency of 50Hz.
EFlickerRemoval60Hz	0x02	Flicker removal for Field frequency of 60Hz.
EFlickerRemovalAuto	0x04	Auto flicker removal.
EFlickerRemovalSwitchOff	0x08	Switch Off flicker removal.

Enum TFocusMode

Supported focus modes.

Enumerator	Value	Description
EFocusModeUnknown	0x00	Focus mode is unknown.
EFocusModeAuto	0x01	Focus is automatic, default.
EFocusModeFixed	0x02	Focus is fixed.
EFocusModeManual	0x04	Focus is manually set.

Enum TFocusRange

Supported focus ranges.

Enumerator	Value	Description
EFocusRangeAuto	0x00	Auto. Default
EFocusRangeMacro	0x01	Focus operates in close range (macro).
EFocusRangeNormal	0x02	Normal operation.
EFocusRangeTele	0x04	Extended (tele) operation.
EFocusRangePortrait	0x08	Focus at larger areas at short to medium distance.
EFocusRangeSuperMacro	0x10	Optimised macro operation, where depth of field is very shallow and observation area changes quickly.
EFocusRangeHyperfocal	0x20	All objects at distances from half of the hyperfocal distance out to infinity will be in focus. This gives gives maximum depth of field. This enum value is available from the 'supported' or 'getter' methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L().
EFocusRangeInfinite	0x40	When there is a near obstacle or better focus wanted for far away objects. This enum value is available from the 'supported' or 'getter' methods only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L().

Enum TISORateType

Specifies the ISO type supported by the camera. ISO refers to the sensivity of the image sensor and is one of the factors influencing the exposure.

Enumerator	Value	Description
EISONone	0x00	ISO Not supported. Camera uses a fixed ISO rate internally and never reveals this information.
EISOManual	0x01	Camera gives a list of manual ISO rates to the user to set. Recommendation is to start camera in the manual ISO mode, by default.
EISOAutoUnPrioritised	0x02	Camera chooses the ISO on its own without prioritising any particular exposure parameters.
EISOAutoISOPrioritised	0x04	Camera chooses the ISO on its own by prioritising ISO.
EISOAutoShutterSpeedPrioritised	0x08	Camera chooses the ISO on its own after prioritising shutter speed.
EISOAutoAperturePrioritised	0x10	Camera chooses the ISO on its own after prioritising aperture opening.

Enum TLEDEffect

Specifes the type of LED effects available. The enumeration list may be extended in future.

Enumerator	Value	Description
ELEDEffectNone	0x00	Not supported.
ELEDEffectHardwired	0x01	LED always on.
ELEDEffectAuto	0x02	LED auto.
ELEDEffectManualSwitchOn	0x04	LED Effect manually switched on.
ELEDEffectSwitchOff	0x08	LED Effect switched off.
ELEDEffectCustom	0x10	LED Custom Effect.

Enum TLEDEvent

Specifies the various events for which the LED effects could be used. The enumeration list may be extended in future.

Enumerator	Value	Description
ELEDEventNone	0x00	Not supported.
ELEDEventSelfTimer	0x01	LED effect needed for self timer.
ELEDEventViewfinderStart	0x02	LED effect needed for starting of viewfinder.
ELEDEventViewfinderStop	0x04	LED effect needed for stoping of viewfinder.
ELEDEventStillImageCapture	0x08	LED effect needed for still image capture.
ELEDEventVideoRecording	0x10	LED effect needed for video recording.

Enum TMeteringMode

Specifies the Metering mode for the camera. EMeteringModeAuto is the default value.

Enumerator	Value	Description
EMeteringModeAuto	0x0000	Automatic mode, default.
EMeteringModeCenterWeighted	0x0001	Metering in which the center is given a weighted priority.
EMeteringModeSpot	0x0002	Metering of a central area/spot only, also known as partial.
EMeteringModeEvaluative	0x0004	Metering is evaluated over a matrix(several spots) and calculated as a function of that. Usually best but with increased power consumption. Alternative name multi-metering mode.

Enum TNDFilter

Specifes the type of neutral density filters available. The enumeration list may be extended in future.

Enumerator	Value	Description
ENDFilterNone	0x00	Not Supported.
ENDFilterAuto	0x01	Auto ND Filter.
ENDFilterSwitchedOff	0x02	Switched off ND Filter.
ENDFilterHigh	0x04	High level ND Filter.
ENDFilterMedium	0x08	Medium level ND Filter.
ENDFilterLow	0x10	Low level ND Filter.
ENDFilterGeneral	0x20	General ND Filter.

Enum TPerformanceLevel

Different levels for performance vectors like speed, quality, low memory consumption and low power consumption. The enumeration list may be extended in future.

Enumerator	Value	Description
ELevelHigh	1	High level preference.
ELevelMedium	2	Medium level preference.
ELevelLow	3	Low level preference.
ELevelDontCare	4	Dont care (No preference).

Enum TPictureOrientation

Specifies the orientation of the picture.

Enumerator	Value	Description
EPictureOrientationUnknown	0x00	No information about picture orientation.
EPictureOrientationPortrait	0x01	Portrait - height larger than width.
EPictureOrientationLandscape	0x02	Landscape width larger than height.
EPictureOrientationSquare	0x04	Square width equals the height.

Enum TPixelAspectRatio

Specifies the pixel aspect ratio

Note:

It is specified as a fraction of (x) horizontal pixel size divided by vertical (y) pixel size. The pixel aspect ratio for square pixels is 1/1.

Enumerator	Value	Description
EPixelAspectUnknown	0x00	Pixel ratio undetermined
EPixelAspect1To1	0x01	Pixel Ratio 1:1.
EPixelAspect12To11	0x02	Pixel Ratio 12:11
EEPixelAspect11To10	0x04	Pixel Ratio 11:10.
EEPixelAspect59To54	0x08	Pixel Ratio 59:54.
EEPixelAspect16To11	0x10	Pixel Ratio 16:11. Note: This value is available only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L()
EEPixelAspect10To11	0x20	Pixel Ratio 10:11. Note: This value is available only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L()
EEPixelAspect40To33	0x40	Pixel Ratio 40:33. Note: This value is available only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L()

Enum TPreCaptureWarning

Specifies the unfavourable circumstances as pre capture warnings which may be issued before image/video capture.

Enumerator	Value	Description
EPCWNone	0x0000	No warnings
EPCWOverExposure	0x0001	warning to indicate that camera sensor is over exposed
EPCWUnderExposure	0x0002	warning to indicate that camera sensor is under exposed
EPCWLowLight	0x0004	warning to indicate that camera operates under insufficient lightning conditions
EPCWBadFocus	0x0008	warning to indicate that focussing is not optimum. This is valid for manual/fixed focus only
EPCWHandShakePossible	0x0010	warning to indicate that camera might not be firmly gripped (Tripod required). This is same as long exposure
EPCWNotEnoughPowerForFlash	0x0020	warning to indicate that camera has not enough power to survive the flash operations (battery discharged)
EPCWWrongWhiteBalanceValue	0x0040	warning to indicate that the current white balance is not the desired one
EPCWWrongFlashValue	0x0080	warning to indicate that the current flash value is not the desired one
EPCWWrongDigiZoomValue	0x0100	warning to indicate that the current digital zoom value is not the desired one
EPCWDigiZoomBadQuality	0x0200	warning to indicate that the desired digital zoom affects the quality of image
EPCWFlashNotReady	0x0400	warning to indicate that flash is not ready. Recommendation: user may subscribe for this warning or issue IsFlashReady() also. Using both options is not encouraged
EPCWGeneralWarning	0x0800	unknown reason
EPCWFlashOverheated	0x1000	warning to indicate that flash has been overheated. Note: This value is available only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L()
EPCWFlashNotNeeded	0x2000	warning to indicate that flash will not be fired because of enough ambient light. Note: This value is available only to the API clients using CCamera::New2L() or CCamera::NewDuplicate2L()

Enum TStabilizationAlgorithmComplexity

Supported stabilization algorithms, graded on complexity.

Enumerator	Value	Description
EStabilizationComplexityAuto	0x00	Stabilization algorithm selection is automatic, default.
EStabilizationComplexityLow	0x01	Stabilization algorithm is simple - less precise but fast.
EStabilizationComplexityMedium	0x02	Stabilization algorithm is of medium complexity.
EStabilizationComplexityHigh	0x04	Stabilization algorithm is of high complexity.

Enum TStabilizationEffect

Supported magnitudes of stabilization effect when in manual mode.

Enumerator	Value	Description
EStabilizationOff	0x00	Stabilization effect is off.
EStabilizationAuto	0x01	Stabilization effect is automatic, default.
EStabilizationFine	0x02	Stabilization effect is very small in magnitude.
EStabilizationMedium	0x04	Stabilization effect is average in magnitude.
EStabilizationStrong	0x08	Stabilization effect is large in magnitude.

Enum TStabilizationMode

Specifies stabilization mode of the camera.

Enumerator	Value	Description
EStabilizationModeOff	0x00	Not present or switched off, default
EStabilizationModeHorizontal	0x01	Stabilization only in horizontal direction.
EStabilizationModeVertical	0x02	Stabilization only in vertical direction.
EStabilizationModeRotation	0x04	Rotational stabilization.
EStabilizationModeAuto	0x08	Automatic stabilization.
EStabilizationModeManual	0x10	Manual stabilization.

Enum TWBUnits

Specifies the units supported by the camera for manual white balance setting.

Enumerator	Value	Description
EWBUnknown		The units type is undetermined or not supported.
EWBColorTemperature		The white balance is represented as temperature degrees in Kelvin.
EWBRgb		The white balance is represented as RGB triples.

Enum TYuvRange

Specifies YUV colour space dynamic range.

Note:

video compressors often use narrower than the default range. The nominal Y range is [16:235] and the U and V ranges [16:240].

Enumerator	Value	Description
EYuvRangeUnknown	0x00	Yuv range undetermined
EYuvRangeFull	0x01	Yuv Full Range. The nominal Y,U and V colours range is [0:255].
EYuvRangeVideoCropped	0x02	Yuv Cropped Range. The nominal Y range is [16:235] and the U and V ranges [16:240].

Enum TZoomDirection

Specifies the zoom direction for continuous zoom operation. The enumeration list may be extended in future.

Enumerator	Value	Description
EZoomDirectionNone	0x00	Implies that feature not supported.
EZoomDirectionWide	0x01	Implies zooming out.
EZoomDirectionTele	0x02	Implies zooming in.

Constructor & Destructor Documentation

~CCameraAdvancedSettings ( )

(

)

const

Get the number of images captured normally under EDriveModeBurst condition.

Note:

: due to memory or image size limitations the actual number may be less.

Returns: the number of images set to capture in burst mode.

CameraIndex ( )

IMPORT_C TInt

CameraIndex

(

)

const

Gets current camera index. The index uniquely identifies the camera on the device.

Returns: camera index in the inclusive range of [0:CCamera::CamerasAvailable() - 1].

CameraType ( )

IMPORT_C TCameraType

CameraType

(

)

const

Gets the type of this camera.

CameraType ( TInt )

IMPORT_C TCameraType

CameraType

(

TInt

aCameraIndex

)

Get the type of a specific camera denoted by its index. A pluggable camera may not necessarily be physically present. The type denotes whether the slot allocated to that index is for pluggable or onboard camera.

Parameter	Description
aCameraIndex	An integer in the range of [0: CCamera::CamerasAvailable()-1].

ContinuousAutoFocusTimeout ( )

IMPORT_C TInt

ContinuousAutoFocusTimeout

(

)

const

Gets the current value for continuous autofocus timeout. Timeouts are in microseconds.

Returns: the timeout value in microseconds. Negative value returned means error case (system wide error code) and positive value means current value for continuous autofocus timeout.

CreateContinuousZoomL ( MContinuousZoomObserver &, TContinuousZoomType, CCameraContinuousZoom *& )

IMPORT_C void	CreateContinuousZoomL	(	MContinuousZoomObserver &	aObserver,
			TContinuousZoomType	aContinuousZoomType,
			CCameraContinuousZoom *&	aContinuousZoom
		)

Creates an instance of a CCameraContinuousZoom object and returns it to the client. Ownership of the object is passed to the client.

Note:

Client must not delete the continuous zoom object if CCameraContinuousZoom::StartContinuousZoomL() has been called as MContinuousZoomObserver callbacks are still expected by the implementation. Clients should therefore only delete the object once the MContinuousZoomObserver::ContinuousZoomCompleted() callback has been received or has explicitly stopped the continuous zoom via StopContinuousZoom().

Parameter	Description
aObserver	Reference to a continuous zoom observer which will be used to issue callbacks to the client.
aContinuousZoomType	The continuous zoom type with which the continuous zoom object will be initialised.
aContinuousZoom	Retrieves pointer to the continuous zoom object. Client assumes ownership of the object.

DigitalZoom ( )

IMPORT_C TInt

DigitalZoom

(

)

const

Gets the currently set digital zoom value.

Returns: The currently set digital zoom value. The value is multiplied by KECamFineResolutionFactor to retain precision. Negative value returned means error case (system wide error code) and positive value means current digital zoom.

DriveMode ( )

IMPORT_C TDriveMode

DriveMode

(

)

const

Gets currently active drive mode.

Returns: current drive mode.

EnumerateOperationPreferenceL ( TUint, TPerformanceLevel &, TPerformanceLevel &, TPerformanceLevel &, TPerformanceLevel & )

IMPORT_C void	EnumerateOperationPreferenceL	(	TUint	aOperationPreferenceIndex,
			TPerformanceLevel &	aSpeedLevel,
			TPerformanceLevel &	aQualityLevel,
			TPerformanceLevel &	aLowMemoryConsumptionLevel,
			TPerformanceLevel &	aLowPowerConsumptionLevel
		)	const

Enumerate the available operation preferences.

Note:

It is up to the implementation how the performance levels are achieved. For example, shutter opening, JPEQ quality and parallel buffering in case of streamed image output can be controlled in order to provide the desired performance.

leave: May leave with any error code.

Parameter	Description
aOperationPreferenceIndex	A particular index which represents an operation preference. The level of different performance vectors may be known through other arguments. This varies from 0 to n-1, where n is given by GetNumOperationPreferenceL(n).
aSpeedLevel	A TPerformanceLevel which specifies the speed level related to the index aOperationPreferenceIndex.
aQualityLevel	A TPerformanceLevel which specifies the quality level related to the index aOperationPreferenceIndex.
aLowMemoryConsumptionLevel	A TPerformanceLevel which specifies the low memory consumption level related to the index aOperationPreferenceIndex. The lower the memory consumption, the higher the level.
aLowPowerConsumptionLevel	A TPerformanceLevel which specifies the low power consumption level related to the index aOperationPreferenceIndex. The lower the power consumption, the higher the level.

ExposureCompensation ( )

IMPORT_C TInt

ExposureCompensation

(

)

const

DeprecatedUse TInt GetExposureCompensation(TInt& aExposureCompensation);

Get the current exposure compensation steps. Positive values increase exposure times, negative reduce exposure times. The change is not cumulative i.e. the change is stateless. Each call assumes no previous compensation has been performed i.e. that there is a zero compensation.

Note:

if returned value is 2 (compensation steps) and the current exposure compensation step is 0.3 EV, then the actual compensation effect will be 0.6 EV.

Returns: current number of compensation steps as an integer.

ExposureCompensationStep ( )

IMPORT_C TInt

ExposureCompensationStep

(

)

const

DeprecatedUse TInt GetExposureCompensationStep(TInt& aExposureCompensationStep);

Get current exposure compensation step.

Returns: the current exposure compensation step.

ExposureLockOn ( )

IMPORT_C TBool

ExposureLockOn

(

)

const

Checks whether exposure value is locked or not.

Returns: whether exposure value is locked or not. ETrue if locked, EFalse otherwise.

ExposureMode ( )

IMPORT_C CCamera::TExposure

ExposureMode

(

)

const

Gets the currently set exposure setting value.

Returns: The currently set exposure setting value.

FlashCompensation ( )

IMPORT_C TInt

FlashCompensation

(

)

const

DeprecatedUse TInt GetFlashCompensation(TInt& aFlashCompensation);

Get the current flash compensation value as integer steps. Positive values boost flash power, negative reduce flash power. The change is not cumulative i.e. the change is stateless. Each call assumes no previous compensation has been performed i.e. that there is a zero compensation.

Note:

if returned value is 2 (compensation steps) and the current flash compensation step is 0.3 EV, then the actual compensation effect will be 0.6 EV.

Returns: the current number of compensation steps as an integer.

FlashCompensationStep ( )

IMPORT_C TInt

FlashCompensationStep

(

)

const

DeprecatedUse TInt GetFlashCompensationStep(TInt& aFlashCompensationStep);

Get current flash power compensation step.

Returns: current flash compensation step.

FlashMode ( )

IMPORT_C CCamera::TFlash

FlashMode

(

)

const

Gets the currently set flash mode.

Note:

Clients not using the CCamera::New2L() or CCamera::NewDuplicate2L() would be given CCamera::EFlashAuto if current flash mode exceeds CCamera::EFlashManual

FocusDistance ( )

IMPORT_C TInt

FocusDistance

(

)

const

Get focus distance in millimetres.

Returns: the current focus distance in millimetres, directly from user setting of lenses.

FocusMode ( )

IMPORT_C TFocusMode

FocusMode

(

)

const

Gets current focus mode on the camera. The result is a valid TFocusMode value.

Returns: current focus mode.

FocusRange ( )

IMPORT_C TFocusRange

FocusRange

(

)

const

Gets current focus range on the camera.

Note:

if CCamera::New2L() or CCamera::NewDuplicate2L() is not used to create CCamera object, it is assumed that application is not prepared to receive extra added enum values. So, any extra enum value received from the implementation will be dropped and EFocusRangeAuto would be passed instead. To receive extra added enum values, application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() to create camera object. In this case, application is assumed to be prepared to receive unrecognised enum values

Returns: the current TFocusRange value.

GetAFAssistantLightL ( TAFAssistantLight & )

IMPORT_C void

GetAFAssistantLightL

(

TAFAssistantLight &

aAFAssistantLight

)

const

Get the type ( and state) of AF assistant light currently set.

leave: KErrNotSupported if the implementation of this method or the feature is not supported. May also leave as a result of other errors.

Parameter	Description
aAFAssistantLight	A reference to AF assistant light. If EAFAssistantLightOff, then manual and auto assistant light are switched off. If EAFAssistantLightManualOn, manual assistant light is switched on. If EAFAssistantLightAuto, AF assistant light is set to auto.

GetActiveSettingsL ( RArray< TUid > & )

IMPORT_C void

GetActiveSettingsL

(

RArray< TUid > &

aActiveSettings

)

const

Gets an array of all the advanced settings parameters currently active on the camera. These are identified by UIDs and relate to the set or subset of it of all supported settings UIDs.

leave: KErrNoMemory Out of memory.

Note:

if CCamera::New2L() or CCamera::NewDuplicate2L() is not used to create CCamera object, it is assumed that application is not prepared to receive extra added uid values (new settings added). So, any extra uid value passed from the implementation will be filtered at this point. To receive extra added uid values, application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() to create camera object. In this case, application is assumed to be prepared to receive unrecognised uid values

Parameter	Description
aActiveSettings	An empty array of TUids which would be populated by the implementation with the active setting UIDs. If the array is empty on return, the camera does not support any settings.

GetAperturesL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetAperturesL	(	RArray< TInt > &	aFStops,
			TValueInfo &	aInfo
		)	const

Gets the current discrete aperture steps (F-stops) supported by the camera.

leave: KErrNoMemory Out of memory.

Note:

When camera device is incapable of revealing the aperture openings supported, it has to be assumed that camera will work only on the parmanently set value. If this value is not known, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aFStops	A reference to an empty array of TInt which would be populated by the implementation with the specific supported values. If the array is empty on return, the camera supports all integer values in the aperture range. Each value is multiplied by a factor of KECamFineResolutionFactor.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetBracketMerge ( TInt &, TInt & )

IMPORT_C void	GetBracketMerge	(	TInt &	aStartIndex,
			TInt &	aFrames
		)	const

Gets the settings for which frames to merge. Valid only in EDriveModeBracketMerge mode.

Note:

there must be at least two images to merge. All are assumed to form a sequence and are identified using the first frame index and number of frames e.g. to merge two frames - one on and one +1, when in EBracketMode3Image, one sets the start index to 1 and frames to two.

It is very much TBracketMode setting dependent operation.

Parameter	Description
aStartIndex	the index of the start frame, starts from 0.
aFrames	the number of frames to be merged.

GetCurrentFocusModeStepsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetCurrentFocusModeStepsL	(	RArray< TInt > &	aFocusModeSteps,
			TValueInfo &	aInfo
		)	const

Get the number of focus steps for current focus mode.

leave: KErrNotSupported if the implementation of this method is not supported. May also leave as a result of other system errors.

Note:

When camera device doesn't support this, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aFocusModeSteps	A reference to an empty array of TInt which would be populated by the implementation with the specific supported values.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetDigitalZoomStepsForStillL ( RArray< TInt > &, TValueInfo &, TInt, CCamera::TFormat, TBool & )

IMPORT_C void	GetDigitalZoomStepsForStillL	(	RArray< TInt > &	aDigitalZoomSteps,
			TValueInfo &	aInfo,
			TInt	aSizeIndex,
			CCamera::TFormat	aFormat,
			TBool &	aIsInfluencePossible
		)	const

Get the digital zoom steps for the still image when a particular image format and size are specified.

leave: KErrNotSupported if the implementation of this method is not present. KErrNoMemory if out of memory. May leave as a result of some other error.

Note:

This method retrieves the supported digital zoom steps irrespective of any stabilization influence. In case of stabilization etc. influence, the setting function should set the best possible digital zoom value and return error KErrECamDigitalZoomLimited along with dedicated event.

When concrete implementation is provided, but camera device does not support this feature, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aDigitalZoomSteps	A reference to an empty array of TInt to hold digital zoom step values for still image and multiplied by KECamFineResolutionFactor to retain precision. If list returned is empty, this means feature is not supported.
aInfo	A reference to TValueInfo, which establishes the type of the returned data.
aSizeIndex	A value providing the size index which must be in the range 0 to TCameraInfo::iNumImageSizesSupported-1 inclusive.
aFormat	A value providing the image format which must be one of the formats supported. (see TCameraInfo::iImageFormatsSupported)
aIsInfluencePossible	If True, signals that digital zoom step values may be influenced by some hardware factor like stabilization etc. If False, no influence possible.

GetDigitalZoomStepsForVideoL ( RArray< TInt > &, TValueInfo &, TInt, TInt, CCamera::TFormat, TBool &, CCamera::TExposure )

IMPORT_C void	GetDigitalZoomStepsForVideoL	(	RArray< TInt > &	aDigitalZoomSteps,
			TValueInfo &	aInfo,
			TInt	aFrameRateIndex,
			TInt	aSizeIndex,
			CCamera::TFormat	aFormat,
			TBool &	aIsInfluencePossible,
			CCamera::TExposure	aExposure
		)	const

Get the digital zoom steps for the video when a particular video frame format, size and rate are specified.

leave: KErrNotSupported if the implementation of this method is not present. KErrNoMemory if out of memory. May leave as a result of some other error.

Note:

Parameter	Description
aDigitalZoomSteps	A reference to an empty array of TInt to hold digital zoom step values for video and multiplied by KECamFineResolutionFactor to retain precision. If list returned is empty, this means feature is not supported.
aInfo	A reference to TValueInfo, which establishes the type of the returned data.
aFrameRateIndex	A value providing the rate index must be in the range 0 to TCameraInfo::iNumVideoFrameRatesSupported-1 inclusive.
aSizeIndex	A value providing the size index which must be in the range 0 to TCameraInfo::iNumVideoFrameSizesSupported-1 inclusive.
aFormat	A value providing the format which must be one of the video frame formats supported. (see TCameraInfo::iVideoFrameFormatsSupported)
aIsInfluencePossible	If True, signals that digital zoom step values may be influenced by some hardware factor like stabilization etc. If False, no influence possible.
aExposure	The exposure mode.

GetDigitalZoomStepsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetDigitalZoomStepsL	(	RArray< TInt > &	aDigitalZoomSteps,
			TValueInfo &	aInfo
		)	const

Gets the digital zoom levels.

Note:

Such approach allows for support for both linear and non-linear zoom steps. When camera device doesn't support this, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

leave: KErrNoMemory Out of memory.

Parameter	Description
aDigitalZoomSteps	Array to hold digital zoom values multiplied by KECamFineResolutionFactor to retain precision. So that if zoom is not supported the array will return a single element of value KECamFineResolutionFactor.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetDisabledSettingsL ( RArray< TUid > & )

IMPORT_C void

GetDisabledSettingsL

(

RArray< TUid > &

aDisabledSettings

)

const

Gets an array of all the advanced settings parameters currently disabled on the camera. These are identified by UIDs and relate to the set or subset of it of all supported settings UIDs.

leave: KErrNoMemory Out of memory.

Note:

Parameter	Description
aDisabledSettings	An empty array of TUids which would be populated by the implementation with the disabled setting UIDs. If the array is empty on return, the camera does not support any settings.

GetExposureCompensation ( TInt & )

IMPORT_C TInt

GetExposureCompensation

(

TInt &

aExposureCompensation

)

const

Note:

if retrieved value is 2 (compensation steps) and the current exposure compensation step is 0.3 EV, then the actual compensation effect will be 0.6 EV.

Note:

Use this method in place of deprecated TInt ExposureCompensation()

Parameter	Description
aExposureCompensation	Reference to the current number of compensation steps as an integer.

Returns: system wide error code.

GetExposureCompensationRangeInSteps ( TInt &, TInt & )

IMPORT_C void	GetExposureCompensationRangeInSteps	(	TInt &	aNegativeCompensation,
			TInt &	aPositiveCompensation
		)	const

Get current exposure compensation range in steps. It depends on the previously selected exposure compensation step.

Parameter	Description
aNegativeCompensation	reference to an integer returning the maximum number of steps available for negative compensation,
aPositiveCompensation	reference to an integer returning the maximum number of steps available for positive compensation,

GetExposureCompensationStep ( TInt & )

IMPORT_C TInt

GetExposureCompensationStep

(

TInt &

aExposureCompensationStep

)

const

Get current exposure compensation step.

Note:

Use this method in place of deprecated TInt ExposureCompensationStep()

Parameter	Description
aExposureCompensationStep	Reference to the current exposure compensation step.

Returns: system wide error code.

GetExposureCompensationStepsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetExposureCompensationStepsL	(	RArray< TInt > &	aExposureCompensationSteps,
			TValueInfo &	aInfo
		)	const

Get exposure compensation steps as integers multiplied by KECamFineResolutionFactor. For example 0.3 EV is 30.

leave: KErrNoMemory Out of memory.

Note:

When camera device doesn't support this, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case. When camera device is incapable of revealing the exposure compensation steps supported, it has to be assumed that camera will work only on the permanently set value. If this value is not known, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aExposureCompensationSteps	an RArray of integers which is populated to reflect the supported exposure compensation steps, all values have been multiplied by KECamFineResolutionFactor before truncated to integers.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetFlashCompensation ( TInt & )

IMPORT_C TInt

GetFlashCompensation

(

TInt &

aFlashCompensation

)

const

Note:

if retrieved value is 2 (compensation steps) and the current flash compensation step is 0.3 EV, then the actual compensation effect will be 0.6 EV.

Note:

Use this method in place of deprecated TInt FlashCompensation()

Parameter	Description
aFlashCompensation	Reference to the current number of compensation steps as an integer.

Returns: system wide error code.

GetFlashCompensationRangeInSteps ( TInt &, TInt & )

IMPORT_C void	GetFlashCompensationRangeInSteps	(	TInt &	aNegativeCompensation,
			TInt &	aPositiveCompensation
		)	const

Get current flash power compensation range measured in a already selected compensation step magnitude.

Note:

This range may change if a different compensation step is selected. For example if flash compensation range is in the range -1EV 1.5EV and the selected flash compensation step is selected to be 0.3 EV, the result of this call will be aNegativeCompensation = -3 and aPositiveCompensation = 5. as there can be only three full steps for negative compensation (1/0.3) and five for flash power boost (1.5/0.3). In this way developers, having pre-selected a step value from the supported set, would need to provide just the multiplier (in steps) and the direction (the sign). Steps are always assumed integers.

Parameter	Description
aNegativeCompensation	a reference to an integer returning the maximum number of steps available for negative compensation.
aPositiveCompensation	a reference to an integer returning the maximum number of steps available for positive compensation.

GetFlashCompensationStep ( TInt & )

IMPORT_C TInt

GetFlashCompensationStep

(

TInt &

aFlashCompensationStep

)

const

Get current flash power compensation step.

Note:

Use this method in place of deprecated TInt FlashCompensationStep()

Parameter	Description
aFlashCompensationStep	Reference to the current flash compensation step.

Returns: system wide error code.

GetFlashCompensationStepsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetFlashCompensationStepsL	(	RArray< TInt > &	aFlashCompensationSteps,
			TValueInfo &	aInfo
		)	const

Get flash compensation steps as integers multiplied by KECamFineResolutionFactor. For example 0.5 EV is 50.

GetFocalLengthInfoL ( TInt &, TInt &, TInt & )

IMPORT_C void	GetFocalLengthInfoL	(	TInt &	aMinFocalLength,
			TInt &	aCurrentFocalLength,
			TInt &	aMaxFocalLength
		)	const

Retrieves the minimum, current and maximum focal length in millimeters. This information is useful to find out which zoom directions can be used on the fly.

leave: May leave with any error code.

Parameter	Description
aMinFocalLength	Minimum focal length if positive. Error value if negative (for example, KErrNotFound if information not available).
aCurrentFocalLength	Current focal length if positive. Error value if negative (for example, KErrNotFound if information not available).
aMaxFocalLength	Maximum focal length if positive. Error value if negative (for example, KErrNotFound if information not available).

GetISORateL ( TISORateType &, TInt &, TInt & )

IMPORT_C void	GetISORateL	(	TISORateType &	aISORateType,
			TInt &	aParam,
			TInt &	aISORate
		)	const

Get the type of ISO rate, exposure parameter and value set.

leave: KErrNotSupported if the implementation of this method is not present. May leave as a result of some other error.

Note:

When concrete implementation is provided, but camera device does not support this feature, then aISORateType retrieves EISONone.

Since camera hardware may be incapable of providing the actual ISO value when one of the auto ISO type has been set, then, in these cases, the 3rd argument is retrieved as KErrNotFound.

Parameter	Description
aISORateType	A reference to the type of ISO rate set. EISONone means feature is not supported.
aParam	Depending on the value of aISORateType, possible values of aParam are one of the following:- A reference to the redundant parameter in case of manual type of ISO rate(EISOManual) OR A reference to the redundant parameter in case of unprioritised type of auto ISO(EISOAutoUnPrioritised) OR A reference to the highest ISO rate that may be picked up in case of ISO prioritised type of auto ISO(EISOAutoISOPrioritised) OR A reference to the slowest shutter speed that may be picked up in case of shutter speed prioritised type of auto ISO(EISOAutoShutterSpeedPrioritised) OR A reference to the minimum aperture opening that may be picked up in case of aperture prioritised type of auto ISO(EISOAutoAperturePrioritised)
aISORate	A reference to the value of ISO rate currently being used, if camera device is capable of doing that. Otherwise KErrNotFound is retrieved indicating the incapability of camera.

GetIndirectFeatureChangesL ( TUid, RArray< TUid > & )

IMPORT_C void	GetIndirectFeatureChangesL	(	TUid	aRequestedSetting,
			RArray< TUid > &	aIndirectFeatureChanges
		)	const

Retrieves the indirect feature changes which occur because of a particular requested feature change. Since the camera setting operation is asynchronous in nature, changing a particular camera feature, in certain cases, involves indirectly changing another feature. In order to notify the ECam client about this indirect feature change, event KUidECamEvent2IndirectFeatureChange is issued. After this notification, the client may use this method to retrieve the full list of indirect feature changes.

leave: May leave with any error code.

Parameter	Description
aRequestedSetting	The actual requested feature change. This uid is supposed to be ECAM component wide and not restricted to advanced camera settings.
aIndirectFeatureChanges	An array of uids which retrieves the indirect feature changes. These uids are supposed to be ECAM component wide and not restricted to advanced camera settings.

GetManualFlashPowerLevelsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetManualFlashPowerLevelsL	(	RArray< TInt > &	aManualFlashPowerLevels,
			TValueInfo &	aInfo
		)	const

Gets the current discrete manual flash power levels supported by the camera in range 0-100 as a percentage of maximum power level.

leave: KErrNoMemory Out of memory.

Note:

When camera device doesn't support this, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case. When camera device is incapable of revealing the manual flash power levels supported, it has to be assumed that camera will work only on the permanently set value. If this value is not known, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aManualFlashPowerLevels	An empty array of TInt which would be populated by the implementation with the specific supported values. If the array is empty on return, the camera does not support this functionality.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetMinFocalLength ( )

IMPORT_C TInt

GetMinFocalLength

(

)

const

Get minimum focus distance in millimetres

Note:

Current Focal length is calculated as focalLength = opticalZoom * minFocalLength;

Returns: the minimum (35 camera equivalent) focal length of a camera.

GetNumOperationPreferenceL ( TUint & )

IMPORT_C void

GetNumOperationPreferenceL

(

TUint &

aNumOperationPreferenceSupported

)

const

Retrieves the total number of operation preferences supported by the implementation. Operation preferences are specified in terms of performance vectors, that is, speed, quality, low memory consumption and low power consumption.

leave: May leave with any error code.

Parameter	Description
aNumOperationPreferenceSupported	Retrieves the number of operation preferences supported.

GetOperationPreferenceL ( TInt & )

IMPORT_C void

GetOperationPreferenceL

(

TInt &

aOperationPreferenceIndex

)

const

Get the current operation preference being used.

leave: May leave with any error code.

Parameter	Description
aOperationPreferenceIndex	Currently used operation preference index.

GetOpticalZoomStepsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetOpticalZoomStepsL	(	RArray< TInt > &	aOpticalZoomSteps,
			TValueInfo &	aInfo
		)	const

Gets the optical zoom levels.

Note:

leave: KErrNoMemory Out of memory.

Parameter	Description
aOpticalZoomSteps	Array to hold optical zoom values multiplied by KECamFineResolutionFactor to retain precision. So that if zoom is not supported the array will return a single element of value KECamFineResolutionFactor.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetPreCaptureWarningL ( TInt & )

IMPORT_C void

GetPreCaptureWarningL

(

TInt &

aPreCaptureWarning

)

const

Get the status of every warnings defined.

leave: KErrNotSupported if the implementation of this method or the feature is not supported. May also leave as a result of other errors.

Note:

This method may be called after receiving the event KUidECamEventCameraSettingPreCaptureWarning OR user may also opt for polling on this.

Parameter	Description
aPreCaptureWarning	A reference to the integer - bitfield representing all the TPreCaptureWarning types issued.

GetPreCaptureWarningSupportedL ( TCameraMode, TInt & )

IMPORT_C void	GetPreCaptureWarningSupportedL	(	TCameraMode	aCameraMode,
			TInt &	aPreCaptureWarningSupported
		)	const

Retrieves the pre capture warnings supported for a given camera mode

leave: May leave with any error.

Parameter	Description
aCameraMode	Desired camera mode for which the supported pre capture warnings may be retrieved.
aPreCaptureWarningSupported	A bitfield of all supported TPreCaptureWarning to be issued in the given camera mode. If no pre capture warning supported for the given camera mode, EPCWNone is retrieved.

GetShutterSpeedsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetShutterSpeedsL	(	RArray< TInt > &	aShutterSpeeds,
			TValueInfo &	aInfo
		)	const

Gets the set of supported shutter speeds.

leave: KErrNoMemory Out of memory.

Note:

When camera device is incapable of revealing the shutter speeds supported, it has to be assumed that camera will work only on the parmanently set value. If this value is not known, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aShutterSpeeds	a reference to an RArray of TInt representing the discrete shutter speeds supported currently by the camera.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

Returns: the populated array with all shutter speeds in microseconds.

GetSupportedAFAssistantLightL ( TInt & )

IMPORT_C void

GetSupportedAFAssistantLightL

(

TInt &

aSupportedAFAssistantLight

)

const

Retrieve the different supported AF assistant light.

leave: KErrNotSupported if the implementation of this method is not supported. May also leave as a result of other errors.

Note:

When concrete implementation is provided, but camera device does not support this feature, then aSupportedAFAssistantLight retrieves EAFAssistantLightOff. Corresponding getter/setters for this feature should not be called then.

Parameter

Description

aSupportedAFAssistantLight

A reference to integer - bitfield indicating the supported AF assistant light. If EAFAssistantLightOff, this means AF assistant light is not supported. If EAFAssistantLightManualOn, then manual AF assistant light is supported. If EAFAssistantLightAuto, auto assistant light is supported. If combination of EAFAssistantLightManualOn||EAFAssistantLightAuto , then both manual and Auto assistant light are supported.

GetSupportedContinuousAutoFocusTimeoutsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetSupportedContinuousAutoFocusTimeoutsL	(	RArray< TInt > &	aTimeouts,
			TValueInfo &	aInfo
		)	const

Retrieves the timeout values camera supported by the camera when in continuous auto focus mode. Timeouts are in microseconds.

leave: KErrNoMemory Out of memory.

Note:

When camera device doesn't support this, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aTimeouts	An empty array to hold timeout values.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

GetSupportedContinuousZoomTypeL ( TUint & )

IMPORT_C void

GetSupportedContinuousZoomTypeL

(

TUint &

aSupportedContinuousZoomType

)

const

Retrieves the supported continuous zoom types.

leave: May leave with any error code.

Parameter	Description
aSupportedContinuousZoomType	Retrieves a bitfield of TUint which indicates the supported continuous zoom type as given by CCamera::CCameraAdvancedSettings::TContinuousZoomType

GetSupportedEventsL ( RArray< TUid > & )

IMPORT_C void

GetSupportedEventsL

(

RArray< TUid > &

aSupportedEvents

)

const

Retrieves the event uids which the underlying implementation supports. Client may use these event notifications as milestones in their application.

leave: May leave with any error code.

Note:

This method may retrieve unrecognized events which may be introduced later on.

Parameter	Description
aSupportedEvents	Retrieves as array of TUid. Every member of the array represents a supported event uid. These events are ECAM component wide.

GetSupportedISORateTypeL ( TInt & )

IMPORT_C void

GetSupportedISORateTypeL

(

TInt &

aSupportedISORateTypes

)

const

Gets all supported ISO types on the device.

leave: KErrNotSupported if the implementation of this method is not present. May leave as a result of some other error.

Note:

When concrete implementation is provided, but camera device does not support this feature, then aSupportedISORateTypes retrieves EISONone.

Parameter	Description
aSupportedISORateTypes	A reference to an integer which is a bitfield of all supported TISORateType values. EISONone means feature is not supported.

GetSupportedIsoRatesL ( RArray< TInt > & )

IMPORT_C void

GetSupportedIsoRatesL

(

RArray< TInt > &

aSupportedIsoRates

)

const

Gets the set of camera supported ISO rates.

Note:

When camera device is incapable of revealing the ISO rates supported, it has to be assumed that camera will work only on the permanently set value. If this value is not known, empty array may be returned; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aSupportedIsoRates	an array of integers which gets filled with the supported ISO rates.

GetSupportedSettingsL ( RArray< TUid > & )

IMPORT_C void

GetSupportedSettingsL

(

RArray< TUid > &

aSettings

)

const

Gets an array of all the advanced settings parameters supported by the camera. These are identified by UIDs and relate to the set or subset of it of all defined settings UIDs.

leave: KErrNoMemory Out of memory.

Note:

Parameter	Description
aSettings	An empty array of TUids which would be populated by the implementation with the UIDs of the supported parameters. If the array is empty on return, the camera does not support any settings.

GetTimeLapse ( TTime &, TTime &, TTime & )

IMPORT_C void	GetTimeLapse	(	TTime &	aStart,
			TTime &	aEnd,
			TTime &	aInterval
		)	const

Get current time lapse value. Active only when drive mode EDriveModeTimeLapse. The time lapse is denoted as the uniform time period between consecutive frames and operation is configurable by its start, end and a fixed interval.

Parameter	Description
aStart	the start of the timelapse period.
aEnd	the end of the timelapse period; start < end.
aInterval	the set parameter between two successive snapshots.

GetTimeLapsePeriodRange ( TTime &, TTime & )

IMPORT_C void	GetTimeLapsePeriodRange	(	TTime &	aTimeLapseMin,
			TTime &	aTimeLapseMax
		)	const

Get camera supported time lapse period range. Active only when drive mode EDriveModeTimeLapse. The time lapse is denoted as the uniform time period between consecutive frames.

Parameter	Description
aTimeLapseMin	The minimum time value.
aTimeLapseMax	The maximum time value.

GetTimerIntervalsL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetTimerIntervalsL	(	RArray< TInt > &	aTimerIntervals,
			TValueInfo &	aInfo
		)	const

Get camera supported timer values. Active only when drive mode EDriveModeTimed. Time is in microseconds. As time interval is expected to be relatively short, integer value is considered sufficient.

GetWBRgbValue ( TRgb & )

IMPORT_C void

GetWBRgbValue

(

TRgb &

aValue

)

const

Get white balance value represented as a RGB triplet.

GetWBSupportedColorTemperaturesL ( RArray< TInt > &, TValueInfo & )

IMPORT_C void	GetWBSupportedColorTemperaturesL	(	RArray< TInt > &	aWBColorTemperatures,
			TValueInfo &	aInfo
		)	const

Get the white balance values, as temperature measured in Kelvin, supported on the camera.

Note:

When camera device doesn't support this, empty array may be returned and TValueInfo may be ENotActive; corresponding getter/setters for this feature should not be used in such a case.

Parameter	Description
aWBColorTemperatures	A reference to an empty array of TInt which would be populated by the implementation with the specific supported values.
aInfo	a reference to TValueInfo, which establishes the type of the returned data.

IsCameraPresent ( )

IMPORT_C TBool

IsCameraPresent

(

)

const

Checks whether the current camera is present.

Returns: Whether the camera is currently present. ETrue if camera is present, EFalse otherwise. For example ECameraOnBoard (built-in) cameras are always present.

IsCameraPresent ( TInt )

IMPORT_C TBool

IsCameraPresent

(

TInt

aCameraIndex

)

Checks whether the camera, denoted by its index, is currently present. The index uniquely identifies the camera on the device.

Parameter	Description
aCameraIndex	An integer in the range of [0:CCamera::CamerasAvailable()-1] specifying the camera device to use

Returns: Whether the camera is currently present. ETrue if camera is present, EFalse otherwise. For example built-in (ECameraOnBoard) cameras are always present.

IsExternalFlashPresent ( )

IMPORT_C TBool

IsExternalFlashPresent

(

)

const

Check whether there is an external flash source.

Returns: ETrue if an external flash source is present, EFalse otherwise

IsFlashReady ( TBool & )

IMPORT_C TInt

IsFlashReady

(

TBool &

aReady

)

const

Checks whether the flash is ready.

Parameter	Description
aReady	A reference to a boolean set by the implementation to ETrue if the flash is ready, EFalse otherwise.

Returns: KErrNotSupported if the implementation of this method is not supported.

IsoRate ( )

IMPORT_C TInt

IsoRate

(

)

const

Gets current ISO rate.

Note:

The returned value may be checked with the list of supported ISO rates. If value returned does not belong to this list, then it may be treated as an error case.

Returns: current ISO rate as a TInt value. Negative value returned means error case (system wide error code) and positive value means current ISO rate.

ManualFlashPowerLevel ( )

IMPORT_C TInt

ManualFlashPowerLevel

(

)

const

Gets the current manual flash power level on the camera.

Returns: the current manual flash power level as a value in the range [0:100]. Negative value returned means error case (system wide error code) and positive value means current manual flash power level.

MeteringMode ( )

IMPORT_C TMeteringMode

MeteringMode

(

)

const

Get current metering mode.

Returns: a value of type TMeteringMode.

NewL ( CCamera & )

IMPORT_C CCameraAdvancedSettings *

NewL

(

CCamera &

aCamera

)

[static]

Factory function for creating the CCameraAdvancedSettings object.

leave: KErrNoMemory Out of memory or any other system-wide error code.

Note:

Clients using MCameraObserver are not recommended to use this extension class since they cannot handle events.

Parameter	Description
aCamera	a reference to a CCamera object providing the settings.

Returns: a pointer to a fully constructed CCameraAdvancedSettings object.

OpticalZoom ( )

IMPORT_C TInt

OpticalZoom

(

)

const

Gets the currently set zoom value.

Returns: The currently set optical zoom value. The value is multiplied by KECamFineResolutionFactor to retain precision. Negative value returned means error case (system wide error code) and positive value means current optical zoom.

PictureOrientation ( )

IMPORT_C TPictureOrientation

PictureOrientation

(

)

const

Get current picture orientation

Returns: a TPictureOrientation value.

PixelAspectRatio ( )

IMPORT_C TPixelAspectRatio

PixelAspectRatio

(

)

const

Get current pixel aspect ratio.

Note:

Some of the pixel aspect ratios are available only for clients using either CCamera::New2L() or CCamera::NewDuplicate2L()

Returns: a TPixelAspectRatio value.

RedEyeReduceOn ( )

IMPORT_C TBool

RedEyeReduceOn

(

)

const

Gets whether the flash red eye reduction is switched on.

Returns: The present state - ETrue for switched on and EFalse for switched off.

SetAFAssistantLightL ( TAFAssistantLight )

IMPORT_C void

SetAFAssistantLightL

(

TAFAssistantLight

aAFAssistantLight

)

Set a particular type ( and state) of AF assistant light.

leave: KErrNotSupported if the implementation of this method is not present.

Note:

Triggers KUidECamEventCameraSettingAFAssistantLight to all MCameraObserver2 clients of the camera. HandleEvent is used to report the result or any possible error. New setter functions leave only when implementation is not there.

Parameter	Description
aAFAssistantLight	Type of AF assistant light to be set. If EAFAssistantLightOff, switch off the manual or auto assistant light. If EAFAssistantLightManualOn, manually switch on the assistant light. If EAFAssistantLightAuto, camera will automatically switch it on/off as per the conditions.

SetAperture ( TInt )

IMPORT_C void

SetAperture

(

TInt

aFStop

)

Set a new aperture value. All MCameraObserver2 clients of the camera receive a KUidECamEventCameraSettingAperture event notification when aperture value is changed.

Note:

The aperture parameter value is an integer, multiplied by KECamFineResolutionFactor. For example to set an aperture of F2.8, call SetAperture(280).

Parameter	Description
aFStop	a new aperture value in the supported by the camera range.

SetApertureExposureLockOn ( TBool )

IMPORT_C void

SetApertureExposureLockOn

(

TBool

aAELock

)

Sets the current state for aperture and exposure lock. Triggers a KUidECamEventAELock event to all MCameraObserver2 clients.

Parameter	Description
aAELock	a value whether to lock exposure and aperture together.

SetAutoFocusArea ( TAutoFocusArea )

IMPORT_C void

SetAutoFocusArea

(

TAutoFocusArea

aAutoFocusArea

)

Sets a specific auto focus area on the camera. Focus area change fires a KUidECamEventCameraSettingAutoFocusArea event to all MCameraObserver2 clients of the camera.

Parameter	Description
aAutoFocusArea	Autofocus area selection.

SetAutoFocusLockOn ( TBool )

IMPORT_C void

SetAutoFocusLockOn

(

TBool

aState

)

Sets autofocus lock state. Triggers a KUidECamEventCameraSettingAutoFocusLock event to all MCameraObserver2 clients.

Parameter	Description
aState	Required new state.

SetAutoFocusType ( TAutoFocusType )

IMPORT_C void

SetAutoFocusType

(

TAutoFocusType

aAutoFocusType

)

Sets a specific auto focus type on the camera. The focus type change fires both, KUidECamEventCameraSettingAutoFocusType and KUidECamEventCameraSettingAutoFocusType2 event to all MCameraObserver2 clients of the camera.

Parameter	Description
aAutoFocusType	Autofocus selection.

SetAutomaticSizeSelectionChangeOn ( TBool )

IMPORT_C void

SetAutomaticSizeSelectionChangeOn

(

TBool

aSetOn

)

Allow camera to proactively change image size due external factors. Default value is EFalse. Triggers a KUidECamEventCameraSettingAutomaticSizeSelection event notification.

Parameter	Description
aSetOn	whether the option should be switched on

SetBracketMerge ( TInt, TInt )

IMPORT_C void	SetBracketMerge	(	TInt	aStartIndex,
			TInt	aFrames
		)

Sets the settings for which frames to merge. Valid only in EDriveModeBracketMerge mode.

Note:

It is very TBracketMode setting dependent.

Parameter	Description
aStartIndex	the index of the start frame, starts from 0.
aFrames	the number of frames to be merged.

SetBracketMode ( TBracketMode )

IMPORT_C void

SetBracketMode

(

TBracketMode

aBracketMode

)

Set new bracket mode. All MCameraObserver2 clients are notified with KUidECamEventCameraSettingBracketMode.

Parameter	Description
aBracketMode	new selection for bracket mode of type TBracketMode.

SetBracketParameter ( TBracketParameter )

IMPORT_C void

SetBracketParameter

(

TBracketParameter

aBracketParameter

)

Set new bracket parameter When set all clients are notified with KUidECamEventCameraSettingBracketParameter.

Parameter	Description
aBracketParameter	new selection for parameter type of type TBracketParameter.

SetBracketStep ( TBracketStep )

IMPORT_C void

SetBracketStep

(

TBracketStep

aBracketStep

)

Set new bracket step. All MCameraObserver2 clients are notified with KUidECamEventCameraSettingBracketStep.

Parameter	Description
aBracketStep	new selection for step of type TBracketStep.

SetBurstImages ( TInt )

IMPORT_C void

SetBurstImages

(

TInt

aImages

)

Set the number of images captured normally under EDriveModeBurst condition. Triggers a KUidECamEventBurstImages event to all MCameraObserver2 clients.

Note:

: due to memory or image size limitations the actual number may be less.

Note:

Unless reduced Latency scheme is not used (ie CaptureImageL(TInt aSequenceNumber) or StartPerformantVideoCaptureL()) if an image/video capture is still outstanding, this method may report error KErrInUse.

Parameter	Description
aImages	the number of images set to capture in burst mode

SetContinuousAutoFocusTimeout ( TInt )

IMPORT_C void

SetContinuousAutoFocusTimeout

(

TInt

aTimeout

)

Sets the current value for continuous autofocus timeout. Timeouts are in microseconds. All MCameraObserver2 clients of the camera receive a KUidECamEventCameraSettingsContinuousAutoFocusTimeout event notification when timeout value is changed.

Parameter	Description
aTimeout	the timeout value in microseconds.

SetDigitalZoom ( TInt )

IMPORT_C void

SetDigitalZoom

(

TInt

aDigitalZoom

)

Sets the digital zoom value. Triggers a KUidECamEventCameraSettingDigitalZoom event to all MCameraObserver2 clients.

Parameter	Description
aDigitalZoom	Required zoom value.

SetDriveMode ( TDriveMode )

IMPORT_C void

SetDriveMode

(

TDriveMode

aDriveMode

)

Set the current metering mode. When set all MCameraObserver2 clients are notified with KUidECamEventCameraSettingDriveMode.

Note:

Parameter	Description
aDriveMode	new selection for drive mode value of type TDriveMode.

SetExposureCompensation ( TInt )

IMPORT_C void

SetExposureCompensation

(

TInt

aExposureCompensationInSteps

)

Set the current exposure compensation value as integer steps. Triggers a KUidECamEventCameraSettingExposureCompensation event to all MCameraObserver2 clients.

Parameter	Description
aExposureCompensationInSteps	a required number of compensation steps - negative value reduce the exposure time positive increases the exposure time.

SetExposureCompensationStep ( TInt )

IMPORT_C void

SetExposureCompensationStep

(

TInt

aExposureCompensationStep

)

Set current exposure compensation step as an integer multiplied by KECamFineResolutionFactor. All MCameraObserver2 clients receive a KUidECamEventCameraSettingExposureCompensationStep event, when the value has changed.

Parameter	Description
aExposureCompensationStep	a new value for the exposure compensation step.

SetExposureLockOn ( TBool )

IMPORT_C void

SetExposureLockOn

(

TBool

aState

)

Sets exposure lock state. Triggers a KUidECamEventCameraSettingExposureLock event to all MCameraObserver2 clients.

Parameter	Description
aState	Required new state.

SetExposureMode ( CCamera::TExposure )

IMPORT_C void

SetExposureMode

(

CCamera::TExposure

aExposureMode

)

Sets the exposure mode of the camera. Triggers a KUidECamEventCameraSettingExposureMode event to all MCameraObserver2 clients.

Parameter	Description
aExposureMode	The required exposure adjustment.

SetFlashCompensation ( TInt )

IMPORT_C void

SetFlashCompensation

(

TInt

aFlashCompensationInSteps

)

Set the current flash compensation value as integer steps. Positive values increase power, negative reduce power. The change is not acumulative e.g. the change is stateless. Each call assumes no previous compensation has been performed i.e. that there is a zero compensation. Triggers a KUidECamEventCameraSettingFlashCompensation event.

Parameter	Description
aFlashCompensationInSteps	a required compensation steps - negative value reduce the flash power positive boosts up the flash power.

SetFlashCompensationStep ( TInt )

IMPORT_C void

SetFlashCompensationStep

(

TInt

aFlashCompensationStep

)

Set current flash compensation step as an integer multiplied by KECamFineResolutionFactor. For example to set a compensation of -0.3 EV, one should use a parameter with value -30. All clients receive a KUidECamEventCameraSettingFlashCompensationStep event, when the value has changed.

Parameter	Description
aFlashCompensationStep	a new value for the flash compensation step.

SetFlashMode ( CCamera::TFlash )

IMPORT_C void

SetFlashMode

(

CCamera::TFlash

aMode

)

Sets the flash mode.

Triggers a KUidECamEventCameraSettingFlashMode event to all camera MCameraObserver2 clients.

Parameter	Description
aMode	The required flash mode.

SetFocusDistance ( TInt )

IMPORT_C void

SetFocusDistance

(

TInt

aDistance

)

Set focus distance in millimetres. Focus distance change fires a KUidECamEventCameraSettingFocusDistance event to all MCameraObserver2 clients of the camera.

Note:

KUidECamEvent2CameraSettingFocusDistance may be used to provide the focussing feedback as well. This means that the feedback will state whether the proper focussing has been achieved after setting the given focus distance.

Parameter	Description
aDistance	the new distance value in millimetres.

SetFocusMode ( TFocusMode )

IMPORT_C void

SetFocusMode

(

TFocusMode

aFocusMode

)

Sets a specific focus mode on the camera. Focus mode change fires a KUidECamEventCameraSettingFocusMode event to all MCameraObserver2 clients of the camera.

Parameter	Description
aFocusMode	new focus mode of TFocusMode type.

SetFocusRange ( TFocusRange )

IMPORT_C void

SetFocusRange

(

TFocusRange

aFocusRange

)

Sets a specific focus range on the camera. The focus range change fires both, KUidECamEventCameraSettingFocusRange and KUidECamEventCameraSettingFocusRange2 event to all MCameraObserver2 clients of the camera.

Parameter	Description
aFocusRange	newly selected focus range.

SetISORateL ( TISORateType, TInt )

IMPORT_C void	SetISORateL	(	TISORateType	aISORateType,
			TInt	aParam
		)

Set the type of ISO rate and the exposure parameter or value specified.

leave: KErrNotSupported if the implementation of this method is not present.

Note:

Triggers KUidECamEventCameraSettingIsoRateType to all MCameraObserver2 clients of the camera. HandleEvent is used to report the result or any possible error. New setter functions leave only when implementation is not there.

Parameter

Description

aISORateType

The type of ISO rate to be set.

aParam

Depending on the value of aISORateType, possible values of aParam are one of the following:- The value of ISO rate to be used in case of manual type of ISO rate (EISOManual). OR Redundant parameter in case of unprioritised type of auto ISO (EISOAutoUnPrioritised). It is left to the camera hardware/firmware to decide how the ISO rate is selected. No priority regarding exposure is specified. OR Highest ISO rate to be picked by the camera while deciding for the best exposure in case of ISO prioritised type of auto ISO (EISOAutoISOPrioritised). ISO rate closest to this (and lower) may be used so that best possible exposure is achieved. OR Slowest shutter speed to be picked by the camera while deciding for the best exposure in case of shutter speed prioritised type of auto ISO (EISOAutoShutterSpeedPrioritised). After using this shutter speed, ISO rate is chosen by the camera to achieve proper exposure. Shutter speed closest to this (and faster) may be used so that best possible exposure is achieved. OR Minimum aperture opening (deepest depth of field) to be picked by the camera while deciding for the best exposure in case of aperture prioritised type of auto ISO (EISOAutoAperturePrioritised). After using this aperture opening, ISO rate is chosen by the camera to achieve proper exposure. Aperture opening closest to this (and wider) may be used to achieve best possible exposure.

SetIsoRate ( TInt )

IMPORT_C void

SetIsoRate

(

TInt

aRate

)

Set current ISO rate for the camera. Triggers KUidECamEventCameraSettingIsoRate to all MCameraObserver2 clients of the camera.

Parameter	Description
aRate	required new ISO rate.

SetManualFlashPowerLevel ( TInt )

IMPORT_C void

SetManualFlashPowerLevel

(

TInt

aManualFlashPowerLevel

)

Sets the current manual flash power level on the camera. Triggers a KUidECamEventCameraSettingFlashManualPower event to all MCameraObserver2 clients.

Parameter	Description
aManualFlashPowerLevel	one of the values returned in GetManualFlashPowerLevelsL().

SetMeteringMode ( TMeteringMode )

IMPORT_C void

SetMeteringMode

(

TMeteringMode

aMeteringMode

)

Set the current metering mode. When set, all MCameraObserver2 clients are notified with a KUidECamEventCameraSettingMeteringMode event.

Parameter	Description
aMeteringMode	new selection for metering mode of type TMeteringMode.

SetOperationPreferenceL ( TUint )

IMPORT_C void

SetOperationPreferenceL

(

TUint

aOperationPreferenceIndex

)

Set a particular operation preference.

leave: KErrNotSupported If the implementation of this method is not present.

Note:

Event KUidECamEventCameraSettingOperationPreference is used to notify clients about setting an operation preference.

Parameter	Description
aOperationPreferenceIndex	An index which reveals a set of levels to be used for performance vectors, that is, speed, quality, low memory consumption and low power consumption.

SetOpticalZoom ( TInt )

IMPORT_C void

SetOpticalZoom

(

TInt

aOpticalZoom

)

Sets the zoom using a specific value. Triggers a KUidECamEventCameraSettingOpticalZoom event to all MCameraObserver2 clients.

Parameter	Description
aOpticalZoom	Required zoom value.

SetPictureOrientation ( TPictureOrientation )

IMPORT_C void

SetPictureOrientation

(

TPictureOrientation

aOrientation

)

Set a new picture orientation This triggers a KUidECamEventCameraSettingPictureOrientation event to all MCameraObserver2 clients.

Parameter	Description
aOrientation	a value of TPictureOrientation denoting the new orientation.

SetPixelAspectRatio ( TPixelAspectRatio )

IMPORT_C void

SetPixelAspectRatio

(

TPixelAspectRatio

aPixelAspectRatio

)

Set a new pixel aspect ratio. This triggers a KUidECamEventPixelAspectRatio event to all MCameraObserver2 clients.

Parameter	Description
aPixelAspectRatio	a value of TPixelAspectRatio denoting the new pixel aspect ratio.

SetRedEyeReduceOn ( TBool )

IMPORT_C void

SetRedEyeReduceOn

(

TBool

aState

)

Sets the flash red eye reduction on or off.

Triggers a KUidECamEventCameraSettingFlashRedEyeReduce event to all camera MCameraObserver2 clients.

Parameter	Description
aState	The required state ETrue for switching it on and EFalse for switching it off.

SetReferenceScreenL ( CWsScreenDevice & )

IMPORT_C void

SetReferenceScreenL

(

CWsScreenDevice &

aScreenDevice

)

Provide reference screen for orientation information.

leave: KErrNotSupported if the implementation of this method is not present.

Note:

Triggers KUidECamEventCameraSettingReferenceScreen to all MCameraObserver2 clients of the camera. HandleEvent is used to report the result or any possible error. New setter functions leave only when implementation is not there.

Parameter	Description
aScreenDevice	A reference to the screen device.

SetShootClickOn ( TBool )

IMPORT_C void

SetShootClickOn

(

TBool

aShootClickOn

)

Sets the button clicking sound on /off. Triggers a KUidECamEventSoundClick event to all MCameraObserver2 clients.

Parameter	Description
aShootClickOn	ETrue to switch clicking sound on, EFalse sound is switched off.

SetShutterSpeed ( TInt )

IMPORT_C void

SetShutterSpeed

(

TInt

aShutterSpeed

)

Sets the current shutter speed. When set, all MCameraObserver2 clients of the camera receive a KUidECamEventCameraSettingShutterSpeed event

Parameter	Description
aShutterSpeed	the required shutter speed in microseconds.

SetStabilizationComplexity ( TStabilizationAlgorithmComplexity )

IMPORT_C void

SetStabilizationComplexity

(

TStabilizationAlgorithmComplexity

aComplexity

)

Sets a specific stabilization algorithm on the camera. When a value is set, MCameraObserver2 clients for that camera will receive a KUidECamEventSettingsStabilizationAlgorithmComplexity event notification.

Parameter	Description
aComplexity	stabilization effect selection of type TStabilizationAlgorithmComplexity.

SetStabilizationEffect ( TStabilizationEffect )

IMPORT_C void

SetStabilizationEffect

(

TStabilizationEffect

aEffect

)

Sets a specific stabilization effect on the camera. When a value is set, MCameraObserver2 clients for that camera will receive a KUidECamEventCameraSettingsStabilizationEffect event notification.

Parameter	Description
aEffect	stabilization effect selection of type TStabilizationEffect.

SetStabilizationMode ( TStabilizationMode )

IMPORT_C void

SetStabilizationMode

(

TStabilizationMode

aStabilizationMode

)

Sets a specific stabilization mode on the camera.

Stabilization mode change fires a KUidECamEventCameraSettingStabilizationMode event to all MCameraObserver2 clients of this specific camera.

Parameter	Description
aStabilizationMode	new stabilization mode of TStabilizationMode type.

SetTimeLapse ( const TTime &, const TTime &, const TTime & )

IMPORT_C void	SetTimeLapse	(	const TTime &	aStart,
			const TTime &	aEnd,
			const TTime &	aInterval
		)

Set current time lapse value. Active only when drive mode EDriveModeTimeLapse. The time lapse is denoted as the uniform time period between consecutive frames. Setting triggers a KUidECamEventCameraSettingTimeLapse event to all MCameraObserver2 camera clients.

Parameter	Description
aStart	the start of the timelapse period.
aEnd	the end of the timelapse period; start < end.
aInterval	the set parameter between two successive snapshots.

SetTimerInterval ( TInt )

IMPORT_C void

SetTimerInterval

(

TInt

aTimerInterval

)

Set current timer value. Active only when drive mode EDriveModeTimed. This is the time interval (delay) in microseconds between user pressing the button and image is taken. The setting of the value triggers a KUidECamEventCameraSettingTimerInterval event to all MCameraObserver2 clients.

Parameter	Description
aTimerInterval	The selected timer interval in microseconds.

SetWBColorTemperature ( TInt )

IMPORT_C void

SetWBColorTemperature

(

TInt

aWBColorTemperature

)

Set the white balance as a temperature in Kelvin

Parameter	Description
aWBColorTemperature	white balance value as a temperature in Kelvins.

SetWBRgbValue ( const TRgb & )

IMPORT_C void

SetWBRgbValue

(

const TRgb &

aValue

)

Set white balance value using a RGB triplet. Change in value causes an event notification KUidECamEventCameraSettingsWBValue to be sent to all MCameraObserver2 clients of this camera.

SetWhiteBalanceMode ( CCamera::TWhiteBalance )

IMPORT_C void

SetWhiteBalanceMode

(

CCamera::TWhiteBalance

aWhiteBalanceMode

)

Sets the white balance adjustment of the camera.

No effect if this is not supported, see TCameraInfo::iWhiteBalanceModesSupported. Triggers KUidECamEventCameraSettingWhiteBalanceMode event to all MCameraObserver2 clients.

Parameter	Description
aWhiteBalanceMode	The required white balance mode.

SetYuvRange ( TYuvRange )

IMPORT_C void

SetYuvRange

(

TYuvRange

aYuvRange

)

Set a new YUV range. This triggers a KUidECamEventYuvRange event to all MCameraObserver2 clients.

Parameter	Description
aYuvRange	a value of TYuvRange denoting the new YUV range.

ShootClickOn ( )

IMPORT_C TBool

ShootClickOn

(

)

const

Gets the current state for button clicking sound effect.

Returns: ETrue to switch clicking sound on, EFalse sound off

ShutterSpeed ( )

IMPORT_C TInt

ShutterSpeed

(

)

const

Gets the current shutter speed

Returns: the current shutter speed in microseconds. Negative value returned means error case (system wide error code) and positive value means current shutter speed.

StabilizationComplexity ( )

IMPORT_C TStabilizationAlgorithmComplexity

StabilizationComplexity

(

)

const

Gets current active stabilization algorithm selection on the camera.

Returns: a TStabilizationAlgorithmComplexity value.

StabilizationEffect ( )

IMPORT_C TStabilizationEffect

StabilizationEffect

(

)

const

Gets all supported stabilization effects on the camera.

Returns: an integer - a bitfield of all supported TStabilizationEffect values.

StabilizationMode ( )

IMPORT_C TStabilizationMode

StabilizationMode

(

)

const

Gets current stabilization mode on the camera. The result is a valid TStabilizationMode value.

Returns: current stabilization mode of type TStabilizationMode.

SubscribeToPreCaptureWarningL ( TInt )

IMPORT_C void

SubscribeToPreCaptureWarningL

(

TInt

aPreCaptureWarning

)

Subscribe in order to receive event which indicates warnings on occurrence of some specific unfavourable conditions before image/video capture.

leave: KErrNotSupported if the implementation of this method or the feature is not supported. May also leave as a result of other errors.

Note:

When any of the subscribed warnings (represented by aPreCaptureWarning) get generated by the camera device, event KUidECamEventCameraSettingPreCaptureWarning is issued. TECAMEvent2 class should be used in order to provide the status of every PreCaptureWarning.

Parameter	Description
aPreCaptureWarning	A bitfield specifying all the TPreCaptureWarning types to be subscribed for.

SupportedAutoFocusAreas ( )

IMPORT_C TInt

SupportedAutoFocusAreas

(

)

const

Gets all supported auto focus areas on the camera.

Returns: an integer - a bitfield of al supported TAutoFocusArea values.

SupportedAutoFocusTypes ( )

IMPORT_C TInt

SupportedAutoFocusTypes

(

)

const

Gets all supported auto focus types on the camera.

Returns: an integer - a bitfield of all supported TAutoFocusType values.

SupportedBracketModes ( )

IMPORT_C TInt

SupportedBracketModes

(

)

const

Get all supported bracket modes as bitfields.

Returns: the set of all supported bracket modes as an integer.

SupportedBracketParameters ( )

IMPORT_C TInt

SupportedBracketParameters

(

)

const

Get all supported bracket parameters as bitfields.

Returns: the set of all currently supported bracket modes.

SupportedBracketSteps ( )

IMPORT_C TInt

SupportedBracketSteps

(

)

const

Get all supported bracket steps as bitfields.

Returns: the set of all supported bracket modes.

SupportedDriveModes ( )

IMPORT_C TInt

SupportedDriveModes

(

)

const

Get all supported drive modes as bitfields of TDriveMode type.

Returns: the set of supported drive modes.

SupportedExposureModes ( )

IMPORT_C TInt

SupportedExposureModes

(

)

const

Get Supported exposure modes - bitfields of CCamera::TExposure

Returns: the set of supported exposure modes.

SupportedFlashModes ( )

IMPORT_C TInt

SupportedFlashModes

(

)

const

Get camera all supported flash modes CCamera::TFlash

Note:

Some of the flash modes are available only for clients using either CCamera::New2L() or CCamera::NewDuplicate2L()

SupportedFocusModes ( )

IMPORT_C TInt

SupportedFocusModes

(

)

const

Gets all of the supported focus modes on the camera. The result is a bitfield of the valid TFocusMode flags.

SupportedFocusRanges ( )

IMPORT_C TInt

SupportedFocusRanges

(

)

const

Gets all supported focus ranges on the camera.

Note:

if CCamera::New2L() or CCamera::NewDuplicate2L() is not used to create CCamera object, it is assumed that application is not prepared to receive extra added enum values. So, any extra enum value passed from the implementation will be filtered at this point. To receive extra added enum values, application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() to create camera object. In this case, application is assumed to be prepared to receive unrecognised enum values

Returns: an integer - a bitfield of all supported TFocusRange values.

SupportedMeteringModes ( )

IMPORT_C TInt

SupportedMeteringModes

(

)

const

Get all supported metering modes on this camera represented as bitfield of type TMeteringMode.

Returns: the set of supported metering modes.

SupportedPixelAspectRatios ( )

IMPORT_C TInt

SupportedPixelAspectRatios

(

)

const

Get supported pixel aspect ratio.

Note:

Some of the pixel aspect ratios are available only for clients using either CCamera::New2L() or CCamera::NewDuplicate2L()

Returns: a bitfield of all supported TPixelAspectRatio values.

SupportedStabilizationComplexityValues ( )

IMPORT_C TInt

SupportedStabilizationComplexityValues

(

)

const

Gets all supported stabilization algorithm values on the camera.

Returns: an integer - a bitfield of all supported TStabilizationAlgorithmComplexity values.

SupportedStabilizationEffects ( )

IMPORT_C TInt

SupportedStabilizationEffects

(

)

const

IMPORT_C TInt

SupportedYuvRanges

(

)

const

Get supported YUV ranges.

Returns: a bitfileld of all supported TYuvRange values.

TimerInterval ( )

IMPORT_C TInt

TimerInterval

(

)

const

Get current timer value. Active only when drive mode is EDriveModeTimed. Timer resolution is in microseconds.

Returns: current time interval value. Negative value returned means error case (system wide error code) and positive value means current timer interval.

UnSubscribePreCaptureWarningL ( )

IMPORT_C void

UnSubscribePreCaptureWarningL

(

)

Unsubscribe so that further events are not received when warnings get issued.

leave: KErrNotSupported if the implementation of this method or the feature is not supported. May also leave as a result of other errors.

WBColorTemperature ( )

IMPORT_C TInt

WBColorTemperature

(

)

const

Get the white balance as a temperature in Kelvin

Returns: current white balance value as a temperature in Kelvins. Negative value returned means error case (system wide error code) and positive value means current value for white balance as a temperature in Kelvin.

WhiteBalanceMode ( )

IMPORT_C CCamera::TWhiteBalance

WhiteBalanceMode

(

)

const

Gets the current white balance value.

Note:

if CCamera::New2L() or CCamera::NewDuplicate2L() is not used to create CCamera object, it is assumed that application is not prepared to receive extra added enum values. So, any extra enum value(unrecognised) received from the implementation will be dropped and EWBAuto would be passed instead. To receive extra added enum values, application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() to create camera object. In this case, application is assumed to be prepared to receive unrecognised enum values

Returns: The current white balance value.

YuvRange ( )

IMPORT_C TYuvRange

YuvRange

(

)

const

Get current YUV range.

Returns: a TYuvRange value.

Parameter	Description
aFlashCompensationSteps	an RArray of integers which is populated on return to reflect the supported flash compensation steps,
aInfo	an TValueInfo reference, which establishes the organization of the returned data.

Parameter	Description
aTimerIntervals	an RArray of integers which is populated to reflect the supported timer interval steps.
aInfo	an TValueInfo reference, which establishes the organization of the returned data.