sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @publishedPartner
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef ECAMPLUGIN_H
sl@0: #define ECAMPLUGIN_H
sl@0: 
sl@0: #include <ecam.h>
sl@0: 
sl@0: _LIT8(KECamPluginMatchString, "*"); // ECom insists on something
sl@0: 
sl@0: class CCameraStructure; // declared here.
sl@0: 
sl@0: /**
sl@0: Parent class for CCamera plugin.
sl@0: Abstract class for CCamera plugin, including ECom support.
sl@0:   
sl@0: @see CCamera 
sl@0: */
sl@0: class CCameraPlugin : public CCamera
sl@0: 	{
sl@0: 	friend class CCamera; // so can use internal factory functions etc
sl@0: protected:
sl@0: 
sl@0: 	/**
sl@0: 	@internalComponent
sl@0: 	
sl@0: 	@see CCamera::NewL(MCameraObserver& aObserver,TInt aCameraIndex)	
sl@0: 	*/
sl@0: 	IMPORT_C static CCameraPlugin* NewL(MCameraObserver& aObserver,TInt aCameraIndex, TInt aCameraVersion);
sl@0: 
sl@0: 	/** 
sl@0: 	@internalComponent
sl@0: 	
sl@0: 	@see CCamera::NewDuplicateL(MCameraObserver& aObserver,TInt aCameraHandle)
sl@0: 	*/
sl@0: 	IMPORT_C static CCameraPlugin* NewDuplicateL(MCameraObserver& aObserver,TInt aCameraHandle, TInt aCameraVersion);	
sl@0: 
sl@0:     /** 
sl@0: 	@internalComponent
sl@0: 	
sl@0: 	@see CCamera::NewL(MCameraObserver2& aObserver,TInt aCameraIndex,TInt aPriority)
sl@0: 	*/
sl@0: 	IMPORT_C static CCameraPlugin* NewL(MCameraObserver2& aObserver,TInt aCameraIndex,TInt aPriority, TInt aCameraVersion);
sl@0: 
sl@0: 	/** 
sl@0: 	@internalComponent
sl@0: 
sl@0: 	@see CCamera::NewDuplicateL(MCameraObserver2& aObserver,TInt aCameraHandle)
sl@0: 	*/
sl@0: 	IMPORT_C static CCameraPlugin* NewDuplicateL(MCameraObserver2& aObserver,TInt aCameraHandle, TInt aCameraVersion);
sl@0: 	
sl@0: 	/** 
sl@0: 	@internalComponent
sl@0: 
sl@0: 	@see CCamera::CamerasAvailable()
sl@0: 	*/
sl@0: 	IMPORT_C static TInt CamerasAvailable();
sl@0: 	
sl@0: 	/**
sl@0: 	Returns the camera API version no.
sl@0: 	
sl@0: 	@return Version of the camera API
sl@0: 	*/
sl@0: 	IMPORT_C TInt CameraVersion();
sl@0: 	
sl@0: 	/**
sl@0:     Destructor
sl@0:     */ 
sl@0: 	IMPORT_C ~CCameraPlugin();
sl@0: 
sl@0: protected:
sl@0: 
sl@0: 	/** 
sl@0: 	A call to one of the factory functions firstly loads the plugin, followed by a
sl@0: 	call to this function to complete construction.
sl@0: 	
sl@0: 	Creates an object representing a camera.
sl@0: 	
sl@0: 	@param  aObserver
sl@0: 	        Reference to class derived from MCameraObserver2 designed to receive
sl@0: 	        notification of asynchronous event completion.
sl@0: 	@param	aCameraIndex
sl@0: 	        Index from 0 to CamerasAvailable()-1 inclusive specifying the
sl@0: 	        camera device to use.
sl@0: 	@return Pointer to a fully constructed CCamera object. Ownership is passed
sl@0: 	        to the caller.
sl@0: 
sl@0: 	@leave  May leave with KErrNoMemory or KErrNotSupported if aCameraIndex is
sl@0: 	        out of range.	
sl@0: 	*/
sl@0: 	virtual void Construct2L(MCameraObserver& aObserver,TInt aCameraIndex)=0;
sl@0: 
sl@0: 	/** 
sl@0: 	A call to one of the factory functions firstly loads the plugin, followed by a
sl@0: 	call to this function to complete construction.
sl@0: 	
sl@0: 	Duplicates the original camera object for use by, for example, multimedia systems.
sl@0: 
sl@0: 	May leave with KErrNoMemory or KErrNotFound if aCameraHandle is not valid.
sl@0: 
sl@0: 	@param  aObserver
sl@0: 	        Reference to an observer.
sl@0: 	@param  aCameraHandle Handle of an existing camera object.
sl@0: 
sl@0: 	@return Duplicate of the original camera object. 
sl@0: 	*/
sl@0: 	virtual void Construct2DupL(MCameraObserver& aObserver,TInt aCameraHandle)=0;
sl@0: 	
sl@0:     /** 
sl@0:     A call to one of the factory functions firstly loads the plugin, followed by a
sl@0: 	call to this function to complete construction.
sl@0:     
sl@0: 	Creates an object representing a camera.
sl@0: 	
sl@0: 	@param  aObserver
sl@0: 	        Reference to class derived from MCameraObserver2 designed to receive
sl@0: 	        notification of asynchronous event completion.
sl@0: 	@param	aCameraIndex
sl@0: 	        Index from 0 to CamerasAvailable()-1 inclusive specifying the
sl@0: 	        camera device to use.
sl@0: 	@param	aPriority
sl@0: 	        Value from -100 to 100 indicating relative priority of client to
sl@0: 	        use camera.
sl@0: 
sl@0: 	@return Pointer to a fully constructed CCamera object. Ownership is passed
sl@0: 	        to the caller.
sl@0: 
sl@0: 	@leave  May leave with KErrNoMemory or KErrNotSupported if aCameraIndex is
sl@0: 	        out of range.
sl@0: 	*/
sl@0: 	virtual void Construct2L(MCameraObserver2& aObserver,TInt aCameraIndex,TInt aPriority)=0;
sl@0: 
sl@0: 	/** 
sl@0: 	A call to one of the factory functions firstly loads the plugin, followed by a
sl@0: 	call to this function to complete construction.
sl@0: 	
sl@0: 	Duplicates the original camera object for use by, for example, multimedia systems.
sl@0: 
sl@0: 	May leave with KErrNoMemory or KErrNotFound if aCameraHandle is not valid.
sl@0: 
sl@0: 	@param  aObserver
sl@0: 	        Reference to an observer.
sl@0: 	@param  aCameraHandle Handle of an existing camera object.
sl@0: 
sl@0: 	@leave  May leave with KErrNoMemory or KErrNotFound if aCameraHandle is not valid.	   
sl@0: 
sl@0: 	@return Duplicate of the original camera object. 
sl@0: 	*/
sl@0: 	virtual void Construct2DupL(MCameraObserver2& aObserver,TInt aCameraHandle)=0;
sl@0: 
sl@0: protected:
sl@0: 
sl@0: 	/**
sl@0: 	Default constructor for this class.
sl@0: 	*/
sl@0: 	IMPORT_C CCameraPlugin();
sl@0: 
sl@0: private:
sl@0: 	
sl@0: 	/**
sl@0: 	Returns the loaded plugin.
sl@0: 	
sl@0: 	@return Pointer to the plugin.
sl@0: 	*/
sl@0: 	static CCameraPlugin* NewL(TInt aCameraVersion);
sl@0: 	
sl@0: 	/**
sl@0: 	Returns the loaded plugin.
sl@0: 	Plugin is left on the cleanup stack.
sl@0: 	
sl@0: 	@param aCameraVersion
sl@0: 		   The version of camera API used by applications	
sl@0: 	
sl@0: 	@return Pointer to the plugin.
sl@0: 	*/
sl@0: 	static CCameraPlugin* NewLC(TInt aCameraVersion);
sl@0: 	
sl@0: private:
sl@0: 	CCameraStructure* iCameraStructure;
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS( CCameraStructure ): public CBase
sl@0: 	{
sl@0: public:
sl@0: 	TUid iDestructorKey;
sl@0: 	TInt iCameraVersion;
sl@0: 	};
sl@0: 
sl@0: #endif // ECAMPLUGIN_H