MCameraAdvancedSettings Class Reference
class MCameraAdvancedSettings |
Mixin class for implementation by providers of the Advanced Settings Camera Extension API. 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.
Public Member Functions |
---|
TInt
| Aperture() |
TBool
| ApertureExposureLockOn() |
CCamera::CCameraAdvancedSettings::TAutoFocusArea
| AutoFocusArea() |
TBool
| AutoFocusLockOn() |
CCamera::CCameraAdvancedSettings::TAutoFocusType
| AutoFocusType() |
TBool
| AutomaticSizeSelectionChangeOn() |
CCamera::CCameraAdvancedSettings::TBracketMode
| BracketMode() |
CCamera::CCameraAdvancedSettings::TBracketParameter
| BracketParameter() |
CCamera::CCameraAdvancedSettings::TBracketStep
| BracketStep() |
TInt
| BurstImages() |
TInt
| CameraIndex() |
CCamera::CCameraAdvancedSettings::TCameraType
| CameraType() |
CCamera::CCameraAdvancedSettings::TCameraType
| CameraType(TInt) |
TInt
| ContinuousAutoFocusTimeout() |
TInt
| DigitalZoom() |
CCamera::CCameraAdvancedSettings::TDriveMode
| DriveMode() |
TInt
| ExposureCompensation() |
TInt
| ExposureCompensationStep() |
TBool
| ExposureLockOn() |
CCamera::TExposure
| ExposureMode() |
TInt
| FlashCompensation() |
TInt
| FlashCompensationStep() |
CCamera::TFlash
| FlashMode() |
TInt
| FocusDistance() |
CCamera::CCameraAdvancedSettings::TFocusMode
| FocusMode() |
CCamera::CCameraAdvancedSettings::TFocusRange
| FocusRange() |
void | GetActiveSettingsL(RArray< TUid > &) |
void | GetAperturesL(RArray< TInt > &, TValueInfo &) |
void | GetBracketMerge(TInt &, TInt &) |
void | GetDigitalZoomStepsL(RArray< TInt > &, TValueInfo &) |
void | GetDisabledSettingsL(RArray< TUid > &) |
TInt
| GetExposureCompensation(TInt &) |
void | GetExposureCompensationRangeInSteps(TInt &, TInt &) |
TInt
| GetExposureCompensationStep(TInt &) |
void | GetExposureCompensationStepsL(RArray< TInt > &, TValueInfo &) |
TInt
| GetFlashCompensation(TInt &) |
void | GetFlashCompensationRangeInSteps(TInt &, TInt &) |
TInt
| GetFlashCompensationStep(TInt &) |
void | GetFlashCompensationStepsL(RArray< TInt > &, TValueInfo &) |
void | GetManualFlashPowerLevelsL(RArray< TInt > &, TValueInfo &) |
TInt
| GetMinFocalLength() |
void | GetOpticalZoomStepsL(RArray< TInt > &, TValueInfo &) |
void | GetShutterSpeedsL(RArray< TInt > &, TValueInfo &) |
void | GetSupportedContinuousAutoFocusTimeoutsL(RArray< TInt > &, TValueInfo &) |
void | GetSupportedIsoRatesL(RArray< TInt > &) |
void | GetSupportedSettingsL(RArray< TUid > &) |
void | GetTimeLapse(TTime &, TTime &, TTime &) |
void | GetTimeLapsePeriodRange(TTime &, TTime &) |
void | GetTimerIntervalsL(RArray< TInt > &, TValueInfo &) |
void | GetWBRgbValue(TRgb &) |
void | GetWBSupportedColorTemperaturesL(RArray< TInt > &, TValueInfo &) |
TBool
| IsCameraPresent() |
TBool
| IsCameraPresent(TInt) |
TBool
| IsExternalFlashPresent() |
TInt
| IsoRate() |
TInt
| ManualFlashPowerLevel() |
CCamera::CCameraAdvancedSettings::TMeteringMode
| MeteringMode() |
TInt
| OpticalZoom() |
CCamera::CCameraAdvancedSettings::TPictureOrientation
| PictureOrientation() |
CCamera::CCameraAdvancedSettings::TPixelAspectRatio
| PixelAspectRatio() |
TBool
| RedEyeReduceOn() |
void | Release() |
void | SetAperture(TInt) |
void | SetApertureExposureLockOn(TBool) |
void | SetAutoFocusArea(CCamera::CCameraAdvancedSettings::TAutoFocusArea) |
void | SetAutoFocusLockOn(TBool) |
void | SetAutoFocusType(CCamera::CCameraAdvancedSettings::TAutoFocusType) |
void | SetAutomaticSizeSelectionChangeOn(TBool) |
void | SetBracketMerge(TInt, TInt) |
void | SetBracketMode(CCamera::CCameraAdvancedSettings::TBracketMode) |
void | SetBracketParameter(CCamera::CCameraAdvancedSettings::TBracketParameter) |
void | SetBracketStep(CCamera::CCameraAdvancedSettings::TBracketStep) |
void | SetBurstImages(TInt) |
void | SetContinuousAutoFocusTimeout(TInt) |
void | SetDigitalZoom(TInt) |
void | SetDriveMode(CCamera::CCameraAdvancedSettings::TDriveMode) |
void | SetExposureCompensation(TInt) |
void | SetExposureCompensationStep(TInt) |
void | SetExposureLockOn(TBool) |
void | SetExposureMode(CCamera::TExposure) |
void | SetFlashCompensation(TInt) |
void | SetFlashCompensationStep(TInt) |
void | SetFlashMode(CCamera::TFlash) |
void | SetFocusDistance(TInt) |
void | SetFocusMode(CCamera::CCameraAdvancedSettings::TFocusMode) |
void | SetFocusRange(CCamera::CCameraAdvancedSettings::TFocusRange) |
void | SetIsoRate(TInt) |
void | SetManualFlashPowerLevel(TInt) |
void | SetMeteringMode(CCamera::CCameraAdvancedSettings::TMeteringMode) |
void | SetOpticalZoom(TInt) |
void | SetPictureOrientation(CCamera::CCameraAdvancedSettings::TPictureOrientation) |
void | SetPixelAspectRatio(CCamera::CCameraAdvancedSettings::TPixelAspectRatio) |
void | SetRedEyeReduceOn(TBool) |
void | SetShootClickOn(TBool) |
void | SetShutterSpeed(TInt) |
void | SetStabilizationComplexity(CCamera::CCameraAdvancedSettings::TStabilizationAlgorithmComplexity) |
void | SetStabilizationEffect(CCamera::CCameraAdvancedSettings::TStabilizationEffect) |
void | SetStabilizationMode(CCamera::CCameraAdvancedSettings::TStabilizationMode) |
void | SetTimeLapse(const TTime &, const TTime &, const TTime &) |
void | SetTimerInterval(TInt) |
void | SetWBColorTemperature(TInt) |
void | SetWBRgbValue(const TRgb &) |
void | SetWhiteBalanceMode(CCamera::TWhiteBalance) |
void | SetYuvRange(CCamera::CCameraAdvancedSettings::TYuvRange) |
TBool
| ShootClickOn() |
TInt
| ShutterSpeed() |
CCamera::CCameraAdvancedSettings::TStabilizationAlgorithmComplexity
| StabilizationComplexity() |
CCamera::CCameraAdvancedSettings::TStabilizationEffect
| StabilizationEffect() |
CCamera::CCameraAdvancedSettings::TStabilizationMode
| StabilizationMode() |
TInt
| SupportedAutoFocusAreas() |
TInt
| SupportedAutoFocusTypes() |
TInt
| SupportedBracketModes() |
TInt
| SupportedBracketParameters() |
TInt
| SupportedBracketSteps() |
TInt
| SupportedDriveModes() |
TInt
| SupportedExposureModes() |
TInt
| SupportedFlashModes() |
TInt
| SupportedFocusModes() |
TInt
| SupportedFocusRanges() |
TInt
| SupportedMeteringModes() |
TInt
| SupportedPixelAspectRatios() |
TInt
| SupportedStabilizationComplexityValues() |
TInt
| SupportedStabilizationEffects() |
TInt
| SupportedStabilizationModes() |
CCamera::CCameraAdvancedSettings::TWBUnits
| SupportedWBUnits() |
TInt
| SupportedWhiteBalanceModes() |
TInt
| SupportedYuvRanges() |
TInt
| TimerInterval() |
TInt
| WBColorTemperature() |
CCamera::TWhiteBalance
| WhiteBalanceMode() |
CCamera::CCameraAdvancedSettings::TYuvRange
| YuvRange() |
Member Functions Documentation
Aperture()
TInt
| Aperture | ( | ) | const [pure virtual] |
Get current aperture value. The default aperture value is ECAM implementation specific and could be either auto aperture or any other supported value.
Note:
In case there is an error, a negative error value from system wide error should be returned.
ApertureExposureLockOn()
TBool
| ApertureExposureLockOn | ( | ) | const [pure virtual] |
Gets the current state for aperture and exposure lock.
AutoFocusArea()
Gets current chosen auto focus area on the device.
AutoFocusLockOn()
TBool
| AutoFocusLockOn | ( | ) | const [pure virtual] |
Checks whether AutoFocus value is locked or not.
AutoFocusType()
Gets current auto focus type on the device.
AutomaticSizeSelectionChangeOn()
TBool
| AutomaticSizeSelectionChangeOn | ( | ) | const [pure virtual] |
Retrieves the state for automatic size selection option. Default value is EFalse.
BracketMode()
Get current bracket mode.
BracketParameter()
Get current bracket parameter.
BracketStep()
Get current bracket step.
BurstImages()
TInt
| BurstImages | ( | ) | const [pure virtual] |
Get the number of images captured normally under EDriveModeBurst condition.
Note: : due to memory or image size limitations the actual number may be less.
CameraIndex()
TInt
| CameraIndex | ( | ) | const [pure virtual] |
Gets current camera index. The index uniquely identifies the camera on the device.
CameraType()
Gets the type of this camera. TCameraType
CameraType(TInt)
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.
Parameters
TInt aCameraIndex | An integer in the range of [0: CCamera::CamerasAvailable()-1]. |
ContinuousAutoFocusTimeout()
TInt
| ContinuousAutoFocusTimeout | ( | ) | const [pure virtual] |
Gets the current value for continuous autofocus timeout. Timeouts are in microseconds.
Note:
In case there is an error, a negative error value from system wide error should be returned.
DigitalZoom()
TInt
| DigitalZoom | ( | ) | const [pure virtual] |
Gets the currently set digital zoom value.
Note:
In case there is an error, a negative error value from system wide error should be returned.
DriveMode()
Gets currently active drive mode.
ExposureCompensation()
TInt
| ExposureCompensation | ( | ) | const [pure virtual] |
Use TInt GetExposureCompensation(TInt& aExposureCompensation);
Get the current exposure compensation value as integer 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.
ExposureCompensationStep()
TInt
| ExposureCompensationStep | ( | ) | const [pure virtual] |
Use TInt GetExposureCompensationStep(TInt& aExposureCompensationStep);
Get current exposure compensation step.
ExposureLockOn()
TBool
| ExposureLockOn | ( | ) | const [pure virtual] |
Checks whether exposure value is locked or not.
ExposureMode()
Gets the currently set exposure setting value.
FlashCompensation()
TInt
| FlashCompensation | ( | ) | const [pure virtual] |
Use 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.
FlashCompensationStep()
TInt
| FlashCompensationStep | ( | ) | const [pure virtual] |
Use TInt GetFlashCompensationStep(TInt& aFlashCompensationStep);
Get current flash power compensation step.
FlashMode()
Gets the currently set flash mode.
FocusDistance()
TInt
| FocusDistance | ( | ) | const [pure virtual] |
Get focus distance in millimetres.
FocusMode()
Gets current focus mode on the device. The result is a valid TFocusMode value.
FocusRange()
Gets current focus range on the device.
GetActiveSettingsL(RArray< TUid > &)
void | GetActiveSettingsL | ( | RArray< TUid > & | aActiveSettings | ) | const [pure virtual] |
Gets an array of all the advanced settings parameters currently active on the device. These are identified by UIDs and relate to the set or subset of it of all supported settings UIDs.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Parameters
RArray< TUid > & 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 &)
Gets the current discrete aperture steps (F-stops) supported by the device.
-
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 should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & 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. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetBracketMerge(TInt &, TInt &)
void | GetBracketMerge | ( | TInt & | aStartIndex, |
| TInt & | aFrames |
| ) | const [pure virtual] |
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.
Parameters
TInt & aStartIndex | the index of the start frame, starts from 0. |
TInt & aFrames | the number of frames to be merged. |
GetDigitalZoomStepsL(RArray< TInt > &, TValueInfo &)
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 should be returned and TValueInfo should be ENotActive and the corresponding getter/setters for this feature should not be used.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Parameters
RArray< TInt > & 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. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetDisabledSettingsL(RArray< TUid > &)
void | GetDisabledSettingsL | ( | RArray< TUid > & | aDisabledSettings | ) | const [pure virtual] |
Gets an array of all the advanced settings parameters currently disabled on the device. These are identified by UIDs and relate to the set or subset of it of all supported settings UIDs.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Parameters
RArray< TUid > & 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 &)
TInt
| GetExposureCompensation | ( | TInt & | aExposureCompensation | ) | const [pure virtual] |
Get the current exposure compensation value as integer 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 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.
Parameters
TInt & aExposureCompensation | Reference to the current number of compensation steps as an integer. |
GetExposureCompensationRangeInSteps(TInt &, TInt &)
void | GetExposureCompensationRangeInSteps | ( | TInt & | aNegativeCompensation, |
| TInt & | aPositiveCompensation |
| ) | const [pure virtual] |
Parameters
TInt & aNegativeCompensation | reference to an integer returning the maximum number of steps available for negative compensation. |
TInt & aPositiveCompensation | reference to an integer returning the maximum number of steps available for positive compensation. |
GetExposureCompensationStep(TInt &)
TInt
| GetExposureCompensationStep | ( | TInt & | aExposureCompensationStep | ) | const [pure virtual] |
Get current exposure compensation step.
Parameters
TInt & aExposureCompensationStep | Reference to the current exposure compensation step. |
GetExposureCompensationStepsL(RArray< TInt > &, TValueInfo &)
void | GetExposureCompensationStepsL | ( | RArray< TInt > & | aExposureCompensationSteps, |
| TValueInfo & | aInfo |
| ) | const [pure virtual] |
Get exposure compensation steps as integers multiplied by KECamFineResolutionFactor. For example 0.3 EV is 30.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Note:
When camera device doesn't support this, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used. When camera device is incapable of revealing the exposure compensation steps supported, it has to be assumed that camera will work only on the parmanently set value. If this value is not known, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & 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. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetFlashCompensation(TInt &)
TInt
| GetFlashCompensation | ( | TInt & | aFlashCompensation | ) | const [pure virtual] |
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 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.
Parameters
TInt & aFlashCompensation | Reference to the current number of compensation steps as an integer. |
GetFlashCompensationRangeInSteps(TInt &, TInt &)
void | GetFlashCompensationRangeInSteps | ( | TInt & | aNegativeCompensation, |
| TInt & | aPositiveCompensation |
| ) | const [pure virtual] |
Get current flash power compensation range measured in a already selected compensation step.
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 multplier (in steps) and the direction (the sign). Steps are always assumed integers.
Parameters
TInt & aNegativeCompensation | reference to an integer returning the maximum number of steps available for negative compensation. |
TInt & aPositiveCompensation | reference to an integer returning the maximum number of steps available for positive compensation. |
GetFlashCompensationStep(TInt &)
TInt
| GetFlashCompensationStep | ( | TInt & | aFlashCompensationStep | ) | const [pure virtual] |
Get current flash power compensation step.
Parameters
TInt & aFlashCompensationStep | Reference to the current flash power compensation step. |
GetFlashCompensationStepsL(RArray< TInt > &, TValueInfo &)
void | GetFlashCompensationStepsL | ( | RArray< TInt > & | aFlashCompensationSteps, |
| TValueInfo & | aInfo |
| ) | const [pure virtual] |
Get flash compensation steps as integers multiplied by KECamFineResolutionFactor. For example 0.5 EV is 50.
TValueInfo
-
leave
- KErrNoMemory Out of memory.
Note:
When camera device doesn't support this, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used. When camera device is incapable of revealing the flash compensation steps supported, it has to be assumed that camera will work only on the parmanently set value. If this value is not known, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & aFlashCompensationSteps | an RArray of integers which is populated on return to reflect the supported flash compensation steps. |
TValueInfo & aInfo | an TValueInfo reference, which establishes the organization of the returned data. |
GetManualFlashPowerLevelsL(RArray< TInt > &, TValueInfo &)
void | GetManualFlashPowerLevelsL | ( | RArray< TInt > & | aManualFlashPowerLevels, |
| TValueInfo & | aInfo |
| ) | const [pure virtual] |
Gets the current discrete manual flash power levels supported by the device 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 should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used. 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 parmanently set value. If this value is not known, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & 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. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetMinFocalLength()
TInt
| GetMinFocalLength | ( | ) | const [pure virtual] |
Get minimum focus distance in millimetres.
Note:
Current Focal length is calculated as focalLength = opticalZoom * minFocalLength;
GetOpticalZoomStepsL(RArray< TInt > &, TValueInfo &)
Gets the optical 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 should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Parameters
RArray< TInt > & 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. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetShutterSpeedsL(RArray< TInt > &, TValueInfo &)
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 should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & aShutterSpeeds | a reference to an RArray of TInt representing the discrete shutter speeds supported currently by the device. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetSupportedContinuousAutoFocusTimeoutsL(RArray< TInt > &, TValueInfo &)
void | GetSupportedContinuousAutoFocusTimeoutsL | ( | RArray< TInt > & | aTimeouts, |
| TValueInfo & | aInfo |
| ) | const [pure virtual] |
Retrieves the timeout values camera supported by the camera when in continuous auto focus mode. Timeouts are in microseconds.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Note:
When camera device doesn't support this, empty array should be returned and TValueInfo should be ENotActive and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & aTimeouts | An empty array to hold timeout values. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
GetSupportedIsoRatesL(RArray< TInt > &)
void | GetSupportedIsoRatesL | ( | RArray< TInt > & | aSupportedIsoRates | ) | const [pure virtual] |
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 parmanently set value. If this value is not known, empty array should be returned, and the corresponding getter/setters for this feature for this feature should not be used.
Parameters
RArray< TInt > & aSupportedIsoRates | an array of integers which gets filled in with the supported ISO rates. |
GetSupportedSettingsL(RArray< TUid > &)
void | GetSupportedSettingsL | ( | RArray< TUid > & | aSettings | ) | const [pure virtual] |
Gets an array of all the advanced settings parameters supported by the device. These are identified by UIDs and relate to the set or subset of it of all defined settings UIDs.
-
leave
- KErrNoMemory Out of memory. May also leave as a result of other system errors.
Parameters
RArray< TUid > & 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 &)
void | GetTimeLapse | ( | TTime & | aStart, |
| TTime & | aEnd, |
| TTime & | aInterval |
| ) | const [pure virtual] |
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.
Parameters
TTime & aStart | the start of the timelapse period |
TTime & aEnd | the end of the timelapse period; start < end. |
TTime & aInterval | the set parameter between two successive snapshots. |
GetTimeLapsePeriodRange(TTime &, TTime &)
void | GetTimeLapsePeriodRange | ( | TTime & | aTimeLapseMin, |
| TTime & | aTimeLapseMax |
| ) | const [pure virtual] |
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.
Parameters
TTime & aTimeLapseMin | The minimum time value. |
TTime & aTimeLapseMax | The maximum time value. |
GetTimerIntervalsL(RArray< TInt > &, TValueInfo &)
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.
TValueInfo
Note:
When camera device doesn't support this, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & aTimerIntervals | an RArray of integers which is populated to reflect the supported timer interval steps. |
TValueInfo & aInfo | an TValueInfo reference, which establishes the organization of the returned data. |
GetWBRgbValue(TRgb &)
void | GetWBRgbValue | ( | TRgb & | aValue | ) | const [pure virtual] |
Get white balance value represented as a RGB triplet (TRgb)
Parameters
TRgb & aValue | a reference to TRgb object which will contain the current white balance. |
GetWBSupportedColorTemperaturesL(RArray< TInt > &, TValueInfo &)
void | GetWBSupportedColorTemperaturesL | ( | RArray< TInt > & | aWBColorTemperatures, |
| TValueInfo & | aInfo |
| ) | const [pure virtual] |
Get the white balance values, as temperature measured in Kelvin, supported on the device.
Note:
When camera device doesn't support this, empty array should be returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.
Parameters
RArray< TInt > & aWBColorTemperatures | A reference to an empty array of TInt which would be populated by the implementation with the specific supported values. |
TValueInfo & aInfo | a reference to TValueInfo, which establishes the type of the returned data. |
IsCameraPresent()
TBool
| IsCameraPresent | ( | ) | const [pure virtual] |
Checks whether the current camera is present.
IsCameraPresent(TInt)
TBool
| IsCameraPresent | ( | TInt | aCameraIndex | ) | const [pure virtual] |
Checks whether the camera, denoted by its index, is currently present. The index uniquely identifies the camera on the device.
Parameters
TInt aCameraIndex | An integer in the range of [0:CCamera::CamerasAvailable()-1] specifying the camera device to use |
IsExternalFlashPresent()
TBool
| IsExternalFlashPresent | ( | ) | const [pure virtual] |
Check whether there is an external flash source.
IsoRate()
TInt
| IsoRate | ( | ) | const [pure virtual] |
Gets current ISO rate.
Note:
In case there is an error, a negative error value from system wide error should be returned.
ManualFlashPowerLevel()
TInt
| ManualFlashPowerLevel | ( | ) | const [pure virtual] |
Gets the current manual flash power level on the device.
Note:
In case there is an error, a negative error value from system wide error should be returned.
MeteringMode()
Get current metering mode.
OpticalZoom()
TInt
| OpticalZoom | ( | ) | const [pure virtual] |
Gets the currently set zoom value.
Note:
In case there is an error, a negative error value from system wide error should be returned.
PictureOrientation()
Get current picture orientation.
PixelAspectRatio()
Get current pixel aspect ratio.
RedEyeReduceOn()
TBool
| RedEyeReduceOn | ( | ) | const [pure virtual] |
Gets whether the flash red eye reduction is switched on.
Release()
void | Release | ( | ) | [pure virtual] |
SetAperture(TInt)
void | SetAperture | ( | TInt | aFStop | ) | [pure virtual] |
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).
Parameters
TInt aFStop | a new aperture value in the supported by the device range. |
SetApertureExposureLockOn(TBool)
void | SetApertureExposureLockOn | ( | TBool | aAELock | ) | [pure virtual] |
Sets the current state for aperture and exposure lock. Triggers a KUidECamEventAELock event to all MCameraObserver2 clients.
Parameters
TBool aAELock | a value whether to lock exposure and aperture together. |
SetAutoFocusArea(CCamera::CCameraAdvancedSettings::TAutoFocusArea)
Sets a specific auto focus area on the device. Focus area change fires a KUidECamEventCameraSettingAutoFocusArea event to all MCameraObserver2 clients of the camera.
SetAutoFocusLockOn(TBool)
void | SetAutoFocusLockOn | ( | TBool | aState | ) | [pure virtual] |
Sets autofocus lock state. Triggers a KUidECamEventCameraSettingAutoFocusLock event to all MCameraObserver2 clients.
Parameters
TBool aState | Required new state. |
SetAutoFocusType(CCamera::CCameraAdvancedSettings::TAutoFocusType)
SetAutomaticSizeSelectionChangeOn(TBool)
void | SetAutomaticSizeSelectionChangeOn | ( | TBool | aSetOn | ) | [pure virtual] |
Allow camera to proactively change image size due external factors. Default value is EFalse. Triggers a KUidECamEventCameraSettingAutomaticSizeSelection event notification.
Parameters
TBool aSetOn | whether the option should be switched on |
SetBracketMerge(TInt, TInt)
void | SetBracketMerge | ( | TInt | aStartIndex, |
| TInt | aFrames |
| ) | [pure virtual] |
Sets 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 2. MCameraObserver2 clients are notified with a KUidECamEventBracketMerge event.
It is very TBracketMode setting dependent.
Parameters
TInt aStartIndex | the index of the start frame, starts from 0. |
TInt aFrames | the number of frames to be merged. |
SetBracketMode(CCamera::CCameraAdvancedSettings::TBracketMode)
Set new bracket mode. All MCameraObserver2 clients are notified with a KUidECamEventCameraSettingBracketMode event.
SetBracketParameter(CCamera::CCameraAdvancedSettings::TBracketParameter)
Set new bracket parameter When set all clients are notified with a KUidECamEventCameraSettingBracketParameter event.
SetBracketStep(CCamera::CCameraAdvancedSettings::TBracketStep)
Set new bracket step. All MCameraObserver2 clients are notified with KUidECamEventCameraSettingBracketStep.
SetBurstImages(TInt)
void | SetBurstImages | ( | TInt | aImages | ) | [pure virtual] |
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 PerformantStopVideoCaptureL()) if an image/video capture is still outstanding, this method may report error KErrInUse.
Parameters
TInt aImages | the number of images set to capture in burst mode. |
SetContinuousAutoFocusTimeout(TInt)
void | SetContinuousAutoFocusTimeout | ( | TInt | aTimeout | ) | [pure virtual] |
Sets new 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.
Parameters
TInt aTimeout | a new timeout value in microseconds. |
SetDigitalZoom(TInt)
void | SetDigitalZoom | ( | TInt | aDigitalZoom | ) | [pure virtual] |
Sets the digital zoom value. Triggers a KUidECamEventCameraSettingDigitalZoom event to all MCameraObserver2 clients.
Parameters
TInt aDigitalZoom | Required zoom value. |
SetDriveMode(CCamera::CCameraAdvancedSettings::TDriveMode)
Set the current metering mode. When set all MCameraObserver2 clients are notified with a KUidECamEventCameraSettingDriveMode event.
Note:
Unless reduced Latency scheme is not used (ie CaptureImageL(TInt aSequenceNumber) or PerformantStopVideoCaptureL()) if an image/video capture is still outstanding, this method may report error KErrInUse.
SetExposureCompensation(TInt)
void | SetExposureCompensation | ( | TInt | aExposureCompensationSteps | ) | [pure virtual] |
Set the current exposure compensation value as integer steps. Triggers a KUidECamEventCameraSettingExposureCompensation event to all MCameraObserver2 clients.
Parameters
TInt aExposureCompensationSteps | a required compensation value negative value reduce the exposure time positive increases the exposure time. |
SetExposureCompensationStep(TInt)
void | SetExposureCompensationStep | ( | TInt | aExposureCompensationStep | ) | [pure virtual] |
Set current exposure compensation step as an integer multiplied by KECamFineResolutionFactor. All MCameraObserver2 clients receive a KUidECamEventCameraSettingExposureCompensationStep event, when the value has changed.
Parameters
TInt aExposureCompensationStep | a new value for the exposure compensation step. |
SetExposureLockOn(TBool)
void | SetExposureLockOn | ( | TBool | aState | ) | [pure virtual] |
Sets exposure lock state. Triggers a KUidECamEventCameraSettingExposureLock event to all MCameraObserver2 clients.
Parameters
TBool aState | Required new state. |
SetExposureMode(CCamera::TExposure)
Sets the exposure mode of the device.
Triggers a KUidECamEventCameraSettingExposureMode event to all MCameraObserver2 clients.
SetFlashCompensation(TInt)
void | SetFlashCompensation | ( | TInt | aFlashCompensationSteps | ) | [pure virtual] |
Set the current flash compensation value as integer steps. Positive values increase power, negative reduce 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. Triggers a KUidECamEventCameraSettingFlashCompensation event.
Parameters
TInt aFlashCompensationSteps | a required compensation steps - negative value reduce the flash power positive boosts up the flash power. |
SetFlashCompensationStep(TInt)
void | SetFlashCompensationStep | ( | TInt | aFlashCompensationStep | ) | [pure virtual] |
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.
Parameters
TInt aFlashCompensationStep | a new value for the flash compensation step. |
SetFlashMode(CCamera::TFlash)
Sets the flash mode.
Triggers a KUidECamEventCameraSettingFlashMode event to all camera MCameraObserver2 clients.
SetFocusDistance(TInt)
void | SetFocusDistance | ( | TInt | aDistance | ) | [pure virtual] |
Set focus distance in millimetres. Focus distance change fires a KUidECamEventCameraSettingFocusDistance event to all MCameraObserver2 clients of the camera.
Parameters
TInt aDistance | the current value in millimetres, directly from user setting of lenses. |
SetFocusMode(CCamera::CCameraAdvancedSettings::TFocusMode)
Sets a specific focus mode on the device. Focus mode change fires a KUidECamEventCameraSettingFocusMode event to all MCameraObserver2 clients of the camera.
SetFocusRange(CCamera::CCameraAdvancedSettings::TFocusRange)
SetIsoRate(TInt)
void | SetIsoRate | ( | TInt | aRate | ) | [pure virtual] |
Set current ISO rate for the camera. Triggers a KUidECamEventCameraSettingIsoRate event to all MCameraObserver2 clients of the camera.
Parameters
TInt aRate | required new ISO rate. |
SetManualFlashPowerLevel(TInt)
void | SetManualFlashPowerLevel | ( | TInt | aManualFlashPowerLevel | ) | [pure virtual] |
Sets the current manual flash power level on the device. Triggers a KUidECamEventCameraSettingFlashManualPower event to all MCameraObserver2 clients.
Parameters
TInt aManualFlashPowerLevel | one of the values returned in GetManualFlashPowerLevelsL(). |
SetMeteringMode(CCamera::CCameraAdvancedSettings::TMeteringMode)
Set the current metering mode. When set, all MCameraObserver2 clients are notified with a KUidECamEventCameraSettingMeteringMode event.
SetOpticalZoom(TInt)
void | SetOpticalZoom | ( | TInt | aOpticalZoom | ) | [pure virtual] |
Sets the zoom using a specific value. Triggers a KUidECamEventCameraSettingOpticalZoom event to all MCameraObserver2 clients.
Parameters
TInt aOpticalZoom | Required zoom value. |
SetPictureOrientation(CCamera::CCameraAdvancedSettings::TPictureOrientation)
Set a new picture orientation This triggers a KUidECamEventCameraSettingPictureOrientation event to all MCameraObserver2 clients.
SetPixelAspectRatio(CCamera::CCameraAdvancedSettings::TPixelAspectRatio)
Set a new pixel aspect ratio. This triggers a KUidECamEventPixelAspectRatio event to all MCameraObserver2 clients.
SetRedEyeReduceOn(TBool)
void | SetRedEyeReduceOn | ( | TBool | aState | ) | [pure virtual] |
Sets the flash red eye reduction on or off.
Triggers a KUidECamEventCameraSettingFlashRedEyeReduce event to all camera MCameraObserver2 clients.
Parameters
TBool aState | The required state ETrue for switching it on and EFalse for switching it off. |
SetShootClickOn(TBool)
void | SetShootClickOn | ( | TBool | aShootClickOn | ) | [pure virtual] |
Sets the button clicking sound effect on /off. Triggers a KUidECamEventSoundClick event to all MCameraObserver2 clients.
Parameters
TBool aShootClickOn | boolean, ETrue to switch clicking sound on, EFalse sound is switched off. |
SetShutterSpeed(TInt)
void | SetShutterSpeed | ( | TInt | aShutterSpeed | ) | [pure virtual] |
Sets the current shutter speed. When set, all MCameraObserver2 clients of the camera receive a KUidECamEventCameraSettingShutterSpeed event
Parameters
TInt aShutterSpeed | the required shutter speed in microseconds. |
SetStabilizationComplexity(CCamera::CCameraAdvancedSettings::TStabilizationAlgorithmComplexity)
Sets a specific stabilization algorithm on the device. When a value is set, MCameraObserver2 clients for that camera will receive a KUidECamEventSettingsStabilizationAlgorithmComplexity event notification.
SetStabilizationEffect(CCamera::CCameraAdvancedSettings::TStabilizationEffect)
Sets a specific stabilization effect on the device. When a value is set, MCameraObserver2 clients for that camera will receive a KUidECamEventCameraSettingsStabilizationEffect event notification.
SetStabilizationMode(CCamera::CCameraAdvancedSettings::TStabilizationMode)
Sets a specific stabilization mode on the device.
Stabilization mode change fires a KUidECamEventCameraSettingStabilizationMode event to all MCameraObserver2 clients of this specific camera.
SetTimeLapse(const TTime &, const TTime &, const TTime &)
void | SetTimeLapse | ( | const TTime & | aStart, |
| const TTime & | aEnd, |
| const TTime & | aInterval |
| ) | [pure virtual] |
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.
Parameters
const TTime & aStart | the start of the timelapse period. |
const TTime & aEnd | the end of the timelapse period; start < end. |
const TTime & aInterval | the set parameter between two successive snapshots. |
SetTimerInterval(TInt)
void | SetTimerInterval | ( | TInt | aTimerInterval | ) | [pure virtual] |
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.
Parameters
TInt aTimerInterval | The selected timer interval in microseconds |
SetWBColorTemperature(TInt)
void | SetWBColorTemperature | ( | TInt | aWBColorTemperature | ) | [pure virtual] |
Set white balance value using a temperature, measured in Kelvin. Change in value causes an event notification KUidECamEventCameraSettingsWBValue to be sent to all MCameraObserver2 clients of this camera.
Parameters
TInt aWBColorTemperature | the new white balance value in Kelvin. |
SetWBRgbValue(const TRgb &)
void | SetWBRgbValue | ( | const TRgb & | aValue | ) | [pure virtual] |
Set white balance value using a RGB triplet (TRgb). Change in value causes an event notification KUidECamEventCameraSettingsWBValue to be sent to all MCameraObserver2 clients of this camera.
Parameters
const TRgb & aValue | a const reference to TRgb object, which contains the new white balance. |
SetWhiteBalanceMode(CCamera::TWhiteBalance)
SetYuvRange(CCamera::CCameraAdvancedSettings::TYuvRange)
Set a new YUV range. This triggers a KUidECamEventYuvRange event to all MCameraObserver2 clients.
ShootClickOn()
TBool
| ShootClickOn | ( | ) | const [pure virtual] |
Gets the current state for button clicking sound effect.
ShutterSpeed()
TInt
| ShutterSpeed | ( | ) | const [pure virtual] |
Gets the current shutter speed
Note:
In case there is an error, a negative error value from system wide error should be returned.
StabilizationComplexity()
Gets current active stabilization algorithm selection on the device.
StabilizationEffect()
Gets current active stabilization effect on the device.
StabilizationMode()
Gets current stabilization mode on the device. The result is a valid TStabilizationMode value.
SupportedAutoFocusAreas()
TInt
| SupportedAutoFocusAreas | ( | ) | const [pure virtual] |
Gets all supported auto focus areas on the device.
SupportedAutoFocusTypes()
TInt
| SupportedAutoFocusTypes | ( | ) | const [pure virtual] |
Gets all supported auto focus types on the device.
SupportedBracketModes()
TInt
| SupportedBracketModes | ( | ) | const [pure virtual] |
Get all supported bracket modes as bitfields.
SupportedBracketParameters()
TInt
| SupportedBracketParameters | ( | ) | const [pure virtual] |
Get all supported bracket parameters as bitfields.
SupportedBracketSteps()
TInt
| SupportedBracketSteps | ( | ) | const [pure virtual] |
Get all supported bracket steps as bitfields.
SupportedDriveModes()
TInt
| SupportedDriveModes | ( | ) | const [pure virtual] |
Get all supported drive modes as bitfields of TDriveMode type.
SupportedExposureModes()
TInt
| SupportedExposureModes | ( | ) | const [pure virtual] |
SupportedFlashModes()
TInt
| SupportedFlashModes | ( | ) | const [pure virtual] |
SupportedFocusModes()
TInt
| SupportedFocusModes | ( | ) | const [pure virtual] |
Gets all of the supported focus modes on the device. The result is a bitfield of the valid TFocusMode flags.
SupportedFocusRanges()
TInt
| SupportedFocusRanges | ( | ) | const [pure virtual] |
Gets all supported focus ranges on the device.
SupportedMeteringModes()
TInt
| SupportedMeteringModes | ( | ) | const [pure virtual] |
Get all supported metering modes on this device represented as bitfield of type TMeteringMode.
SupportedPixelAspectRatios()
TInt
| SupportedPixelAspectRatios | ( | ) | const [pure virtual] |
Get supported pixel aspect ratio.
SupportedStabilizationComplexityValues()
TInt
| SupportedStabilizationComplexityValues | ( | ) | const [pure virtual] |
Gets all supported stabilization algorithm values on the device.
SupportedStabilizationEffects()
TInt
| SupportedStabilizationEffects | ( | ) | const [pure virtual] |
Gets all supported stabilization effects on the device.
SupportedStabilizationModes()
TInt
| SupportedStabilizationModes | ( | ) | const [pure virtual] |
Gets all of the supported stabilization modes on the device. The result is a bitfield of the valid TStabilizationMode flags.
SupportedWBUnits()
Gets the units in which the white balance is measured on the device. The methods used to get or set these differ depending on the supported unit type. It is expected that a device will support only a single type or none.
SupportedWhiteBalanceModes()
TInt
| SupportedWhiteBalanceModes | ( | ) | const [pure virtual] |
Gets camera supported set of white balance adjustments.
SupportedYuvRanges()
TInt
| SupportedYuvRanges | ( | ) | const [pure virtual] |
Get supported YUV ranges.
TimerInterval()
TInt
| TimerInterval | ( | ) | const [pure virtual] |
Get current timer value. Active only when drive mode is EDriveModeTimed. Timer resolution is in microseconds.
Note:
In case there is an error, a negative error value from system wide error should be returned.
WBColorTemperature()
TInt
| WBColorTemperature | ( | ) | const [pure virtual] |
Get the white balance as a temperature in Kelvin.
Note:
In case there is an error, a negative error value from system wide error should be returned.
WhiteBalanceMode()
Gets the current white balance value.
YuvRange()
Get the current YUV range.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.