Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
MCameraObserver Class Referenceabstract

Mixin base class for camera clients. More...

#include <ecam.h>

Public Member Functions

virtual void ReserveComplete (TInt aError)=0
 Camera reservation is complete.
 
virtual void PowerOnComplete (TInt aError)=0
 Indicates camera power on is complete.
 
virtual void ViewFinderFrameReady (CFbsBitmap &aFrame)=0
 Tests whether transfer of view finder data has completed.
 
virtual void ImageReady (CFbsBitmap *aBitmap, HBufC8 *aData, TInt aError)=0
 Transfers the current image from the camera to the client.
 
virtual void FrameBufferReady (MFrameBuffer *aFrameBuffer, TInt aError)=0
 Passes a filled frame buffer to the client.
 

Detailed Description

Mixin base class for camera clients.

An application must implement an MCameraObserver or MCameraObserver2 (recommended) in order to use the camera API. This derived class is called when the camera is ready for use, an image has been captured or a buffer of video data is ready, including when errors occur.

Implementations of the camera API should use MCameraObserver::FrameBufferReady() and MFrameBuffer::Release() to co-ordinate the mapping of any special memory objects.

API status
Published to all clients. Released API.

Definition at line 246 of file ecam.h.

Member Function Documentation

◆ FrameBufferReady()

virtual void MCameraObserver::FrameBufferReady ( MFrameBuffer *  aFrameBuffer,
TInt  aError 
)
pure virtual

Passes a filled frame buffer to the client.

Called asynchronously, when a buffer has been filled with the required number of video frames by CCamera::StartVideoCapture().

Parameters
aFrameBufferOn return, a pointer to an MFrameBuffer if successful, or NULL if not successful.
aErrorKErrNone if successful, or an error code if not successful.

◆ ImageReady()

virtual void MCameraObserver::ImageReady ( CFbsBitmap *  aBitmap,
HBufC8 *  aData,
TInt  aError 
)
pure virtual

Transfers the current image from the camera to the client.

Called asynchronously when CCamera::CaptureImage() completes.

Parameters
aBitmapOn return, a pointer to an image held in CFbsBitmap form if this was the format specified in CCamera::PrepareImageCaptureL().
aDataOn return, a pointer to an HBufC8 if this was the format specified in CCamera::PrepareImageCaptureL(). NULL if there was an error.
aErrorKErrNone on success or an error code on failure.

◆ PowerOnComplete()

virtual void MCameraObserver::PowerOnComplete ( TInt  aError)
pure virtual

Indicates camera power on is complete.

Called on completion of CCamera:PowerOn().

Parameters
aErrorKErrNone on success, KErrInUse if the camera is in use by another client or KErrNoMemory if insufficient system memory is available.

◆ ReserveComplete()

virtual void MCameraObserver::ReserveComplete ( TInt  aError)
pure virtual

Camera reservation is complete.

Called asynchronously when CCamera::Reserve() completes.

Parameters
aErrorAn error on failure and KErrNone on success.

◆ ViewFinderFrameReady()

virtual void MCameraObserver::ViewFinderFrameReady ( CFbsBitmap &  aFrame)
pure virtual

Tests whether transfer of view finder data has completed.

Called periodically in response to the use of CCamera::StartViewFinderBitmapsL().

Parameters
aFrameThe view finder frame.

The documentation for this class was generated from the following file: