Symbian^3 Product Developer Library >

MCameraV2Histogram Class Reference

class MCameraV2Histogram

This is a mixin class to be implemented by providers of the extension API for the camera v2 histogram.

Histograms can be sent to the client or directly displayed on the screen.

Note:

This class is intended for sub classing by licensees only.

CCamera::CCameraV2Histogram
Public Member Functions
voidGetDirectHistogramPropertiesL(CCamera::CCameraV2Histogram::TDirectHistogramParameters &)
voidGetDirectHistogramSupportInfoL(TBool &)
voidGetHistogramStateL(TBool &)
voidGetSupportedHistogramsL(TUint &)
voidPrepareClientHistogramL(CCamera::CCameraV2Histogram::THistogramType)
voidPrepareDirectHistogramL(const CCamera::CCameraV2Histogram::TDirectHistogramParameters &)
voidRelease(CCamera::CCameraV2Histogram *)
voidSetHistogramHandle(CCamera::CCameraV2Histogram *)
voidStartHistogram()
voidStopHistogram()
voidUpdateDirectHistogramPropertiesL(const CCamera::CCameraV2Histogram::TDirectHistogramParameters &)

Member Functions Documentation

GetDirectHistogramPropertiesL(CCamera::CCameraV2Histogram::TDirectHistogramParameters &)

voidGetDirectHistogramPropertiesL(CCamera::CCameraV2Histogram::TDirectHistogramParameters &aDirectHistogramParameters)const [pure virtual]

Retrieves the currently used parameters for the direct histogram.

leave
May leave with any error code.

Parameters

CCamera::CCameraV2Histogram::TDirectHistogramParameters & aDirectHistogramParametersRetrieves the parameters currently being used for the direct histogram.

GetDirectHistogramSupportInfoL(TBool &)

voidGetDirectHistogramSupportInfoL(TBool &aIsDirectHistogramSupported)const [pure virtual]

Informs whether or not the direct histogram is supported.

leave
May leave with any error code.

Parameters

TBool & aIsDirectHistogramSupportedETrue implies that direct histogram is supported. EFalse implies that direct histogram is not supported.

GetHistogramStateL(TBool &)

voidGetHistogramStateL(TBool &aIsHistogramActive)const [pure virtual]

Informs whether the histogram is currently active or not. A histogram is in an active state if StartHistogram() has been called on it and has not been yet stopped.

leave
May leave with any error code.

Parameters

TBool & aIsHistogramActiveETrue indicates that the histogram is active. EFalse indicates that the histogram is inactive.

GetSupportedHistogramsL(TUint &)

voidGetSupportedHistogramsL(TUint &aSupportedHistogramType)const [pure virtual]

Retrieves a list of the supported types of histograms.

leave
May leave with any error code.
CCamera::CCameraV2Histogram::THistogramType

Parameters

TUint & aSupportedHistogramTypeA reference to bit field representing the supported types of histograms as given by CCamera:: CCameraV2Histogram::THistogramType

PrepareClientHistogramL(CCamera::CCameraV2Histogram::THistogramType)

voidPrepareClientHistogramL(CCamera::CCameraV2Histogram::THistogramTypeaType)[pure virtual]

Request to prepare a client based histogram.

Note:

A direct histogram is directly embedded into the viewfinder. If a non direct histogram is requested the histogram data will be passed to the camera client.

leave
May leave with any error code.
Note:

Each histogram object will either prepare direct histogram or client histogram. Preparing multiple histograms per object is an invalid case.

PrepareDSAHistogramL

Parameters

CCamera::CCameraV2Histogram::THistogramType aTypeThe type of histogram to be prepared. This must be one of the supported histogram types given by GetSupportedHistogramsL.

PrepareDirectHistogramL(const CCamera::CCameraV2Histogram::TDirectHistogramParameters &)

voidPrepareDirectHistogramL(const CCamera::CCameraV2Histogram::TDirectHistogramParameters &aDirectHistogramParameters)[pure virtual]

Prepares the direct histogram.

leave
May leave with any error code.
Note:

Each histogram object will either prepare direct histogram or client histogram. Preparing multiple histograms per object is an invalid case.

PrepareClientHistogramL

Parameters

const CCamera::CCameraV2Histogram::TDirectHistogramParameters & aDirectHistogramParametersThe parameters required to prepare the direct histogram.

Release(CCamera::CCameraV2Histogram *)

voidRelease(CCamera::CCameraV2Histogram *aHistogramHandle)[pure virtual]

Releases the interface.

Parameters

CCamera::CCameraV2Histogram * aHistogramHandleThe pointer to the histogram class object which would be destroyed by the client.

SetHistogramHandle(CCamera::CCameraV2Histogram *)

voidSetHistogramHandle(CCamera::CCameraV2Histogram *aHistogramHandle)[pure virtual]

The pointer to the V2 Histogram class used to pass back to the client via observer callbacks when direct histogram gets displayed. Implementation is not supposed to not destroy this object.

MCaptureImageObserver MDirectViewFinderObserver MClientViewFinderObserver

Parameters

CCamera::CCameraV2Histogram * aHistogramHandleThe pointer to the histogram class object.

StartHistogram()

voidStartHistogram()[pure virtual]

Request to start getting histogram notifications.

Note:

Histogram should have been prepared before calling this method.

Histogram notifications are sent to the client by using relevant callbacks for image capture, video capture and viewfinders.

MCaptureImageObserver MCaptureVideoObserver MDirectViewFinderObserver MClientViewFinderObserver

StopHistogram()

voidStopHistogram()[pure virtual]

Request to stop generating histogram.

UpdateDirectHistogramPropertiesL(const CCamera::CCameraV2Histogram::TDirectHistogramParameters &)

voidUpdateDirectHistogramPropertiesL(const CCamera::CCameraV2Histogram::TDirectHistogramParameters &aDirectHistogramParameters)[pure virtual]

Update the parameters for the direct histogram.

leave
May leave with any error code.

Parameters

const CCamera::CCameraV2Histogram::TDirectHistogramParameters & aDirectHistogramParametersThe desired parameters which have to be used to update the direct histogram.

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.