1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/imagingandcamerafws/camerafw/Include/ECam/ECamPlugin.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,207 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +/**
1.20 + @file
1.21 + @publishedPartner
1.22 + @released
1.23 +*/
1.24 +
1.25 +#ifndef ECAMPLUGIN_H
1.26 +#define ECAMPLUGIN_H
1.27 +
1.28 +#include <ecam.h>
1.29 +
1.30 +_LIT8(KECamPluginMatchString, "*"); // ECom insists on something
1.31 +
1.32 +class CCameraStructure; // declared here.
1.33 +
1.34 +/**
1.35 +Parent class for CCamera plugin.
1.36 +Abstract class for CCamera plugin, including ECom support.
1.37 +
1.38 +@see CCamera
1.39 +*/
1.40 +class CCameraPlugin : public CCamera
1.41 + {
1.42 + friend class CCamera; // so can use internal factory functions etc
1.43 +protected:
1.44 +
1.45 + /**
1.46 + @internalComponent
1.47 +
1.48 + @see CCamera::NewL(MCameraObserver& aObserver,TInt aCameraIndex)
1.49 + */
1.50 + IMPORT_C static CCameraPlugin* NewL(MCameraObserver& aObserver,TInt aCameraIndex, TInt aCameraVersion);
1.51 +
1.52 + /**
1.53 + @internalComponent
1.54 +
1.55 + @see CCamera::NewDuplicateL(MCameraObserver& aObserver,TInt aCameraHandle)
1.56 + */
1.57 + IMPORT_C static CCameraPlugin* NewDuplicateL(MCameraObserver& aObserver,TInt aCameraHandle, TInt aCameraVersion);
1.58 +
1.59 + /**
1.60 + @internalComponent
1.61 +
1.62 + @see CCamera::NewL(MCameraObserver2& aObserver,TInt aCameraIndex,TInt aPriority)
1.63 + */
1.64 + IMPORT_C static CCameraPlugin* NewL(MCameraObserver2& aObserver,TInt aCameraIndex,TInt aPriority, TInt aCameraVersion);
1.65 +
1.66 + /**
1.67 + @internalComponent
1.68 +
1.69 + @see CCamera::NewDuplicateL(MCameraObserver2& aObserver,TInt aCameraHandle)
1.70 + */
1.71 + IMPORT_C static CCameraPlugin* NewDuplicateL(MCameraObserver2& aObserver,TInt aCameraHandle, TInt aCameraVersion);
1.72 +
1.73 + /**
1.74 + @internalComponent
1.75 +
1.76 + @see CCamera::CamerasAvailable()
1.77 + */
1.78 + IMPORT_C static TInt CamerasAvailable();
1.79 +
1.80 + /**
1.81 + Returns the camera API version no.
1.82 +
1.83 + @return Version of the camera API
1.84 + */
1.85 + IMPORT_C TInt CameraVersion();
1.86 +
1.87 + /**
1.88 + Destructor
1.89 + */
1.90 + IMPORT_C ~CCameraPlugin();
1.91 +
1.92 +protected:
1.93 +
1.94 + /**
1.95 + A call to one of the factory functions firstly loads the plugin, followed by a
1.96 + call to this function to complete construction.
1.97 +
1.98 + Creates an object representing a camera.
1.99 +
1.100 + @param aObserver
1.101 + Reference to class derived from MCameraObserver2 designed to receive
1.102 + notification of asynchronous event completion.
1.103 + @param aCameraIndex
1.104 + Index from 0 to CamerasAvailable()-1 inclusive specifying the
1.105 + camera device to use.
1.106 + @return Pointer to a fully constructed CCamera object. Ownership is passed
1.107 + to the caller.
1.108 +
1.109 + @leave May leave with KErrNoMemory or KErrNotSupported if aCameraIndex is
1.110 + out of range.
1.111 + */
1.112 + virtual void Construct2L(MCameraObserver& aObserver,TInt aCameraIndex)=0;
1.113 +
1.114 + /**
1.115 + A call to one of the factory functions firstly loads the plugin, followed by a
1.116 + call to this function to complete construction.
1.117 +
1.118 + Duplicates the original camera object for use by, for example, multimedia systems.
1.119 +
1.120 + May leave with KErrNoMemory or KErrNotFound if aCameraHandle is not valid.
1.121 +
1.122 + @param aObserver
1.123 + Reference to an observer.
1.124 + @param aCameraHandle Handle of an existing camera object.
1.125 +
1.126 + @return Duplicate of the original camera object.
1.127 + */
1.128 + virtual void Construct2DupL(MCameraObserver& aObserver,TInt aCameraHandle)=0;
1.129 +
1.130 + /**
1.131 + A call to one of the factory functions firstly loads the plugin, followed by a
1.132 + call to this function to complete construction.
1.133 +
1.134 + Creates an object representing a camera.
1.135 +
1.136 + @param aObserver
1.137 + Reference to class derived from MCameraObserver2 designed to receive
1.138 + notification of asynchronous event completion.
1.139 + @param aCameraIndex
1.140 + Index from 0 to CamerasAvailable()-1 inclusive specifying the
1.141 + camera device to use.
1.142 + @param aPriority
1.143 + Value from -100 to 100 indicating relative priority of client to
1.144 + use camera.
1.145 +
1.146 + @return Pointer to a fully constructed CCamera object. Ownership is passed
1.147 + to the caller.
1.148 +
1.149 + @leave May leave with KErrNoMemory or KErrNotSupported if aCameraIndex is
1.150 + out of range.
1.151 + */
1.152 + virtual void Construct2L(MCameraObserver2& aObserver,TInt aCameraIndex,TInt aPriority)=0;
1.153 +
1.154 + /**
1.155 + A call to one of the factory functions firstly loads the plugin, followed by a
1.156 + call to this function to complete construction.
1.157 +
1.158 + Duplicates the original camera object for use by, for example, multimedia systems.
1.159 +
1.160 + May leave with KErrNoMemory or KErrNotFound if aCameraHandle is not valid.
1.161 +
1.162 + @param aObserver
1.163 + Reference to an observer.
1.164 + @param aCameraHandle Handle of an existing camera object.
1.165 +
1.166 + @leave May leave with KErrNoMemory or KErrNotFound if aCameraHandle is not valid.
1.167 +
1.168 + @return Duplicate of the original camera object.
1.169 + */
1.170 + virtual void Construct2DupL(MCameraObserver2& aObserver,TInt aCameraHandle)=0;
1.171 +
1.172 +protected:
1.173 +
1.174 + /**
1.175 + Default constructor for this class.
1.176 + */
1.177 + IMPORT_C CCameraPlugin();
1.178 +
1.179 +private:
1.180 +
1.181 + /**
1.182 + Returns the loaded plugin.
1.183 +
1.184 + @return Pointer to the plugin.
1.185 + */
1.186 + static CCameraPlugin* NewL(TInt aCameraVersion);
1.187 +
1.188 + /**
1.189 + Returns the loaded plugin.
1.190 + Plugin is left on the cleanup stack.
1.191 +
1.192 + @param aCameraVersion
1.193 + The version of camera API used by applications
1.194 +
1.195 + @return Pointer to the plugin.
1.196 + */
1.197 + static CCameraPlugin* NewLC(TInt aCameraVersion);
1.198 +
1.199 +private:
1.200 + CCameraStructure* iCameraStructure;
1.201 + };
1.202 +
1.203 +NONSHARABLE_CLASS( CCameraStructure ): public CBase
1.204 + {
1.205 +public:
1.206 + TUid iDestructorKey;
1.207 + TInt iCameraVersion;
1.208 + };
1.209 +
1.210 +#endif // ECAMPLUGIN_H