camerauis/cameraxui/cxengine/inc/api/cxeengine.h
branchRCL_3
changeset 24 bac7acad7cb3
parent 23 61bc0f252b2b
child 25 2c87b2808fd7
equal deleted inserted replaced
23:61bc0f252b2b 24:bac7acad7cb3
     1 /*
       
     2 * Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 #ifndef CXEENGINE_H
       
    18 #define CXEENGINE_H
       
    19 
       
    20 #include <QObject>
       
    21 #include "cxenamespace.h"
       
    22 #include "cxengine_global.h"
       
    23 
       
    24 class CxeCameraDeviceControl;
       
    25 class CxeViewfinderControl;
       
    26 class CxeSnapshotControl;
       
    27 class CxeStillCaptureControl;
       
    28 class CxeVideoCaptureControl;
       
    29 class CxeAutoFocusControl;
       
    30 class CxeZoomControl;
       
    31 class CxeImageDataQueue;
       
    32 class CxeFeatureManager;
       
    33 class CxeSettings;
       
    34 class CxeMemoryMonitor;
       
    35 class CxeGeoTaggingTrail;
       
    36 
       
    37 /**
       
    38  * CxeEngine provides the the entry point into CameraX engine. This is the
       
    39  * first class the client needs to initialize. CxeEngine then provides
       
    40  * references to other CameraX engine objects.
       
    41  */
       
    42 class CxeEngine : public QObject
       
    43 {
       
    44     Q_OBJECT
       
    45 public:
       
    46     /**
       
    47      * Create a new engine instance. This is the first call the client needs to
       
    48      * do when using CxeEngine.
       
    49      */
       
    50     CAMERAX_ENGINE_EXPORT static CxeEngine* createEngine();
       
    51 
       
    52     virtual ~CxeEngine();
       
    53 
       
    54     /**
       
    55      * Access the camera device control.
       
    56      */
       
    57     virtual CxeCameraDeviceControl &cameraDeviceControl() = 0;
       
    58 
       
    59     /**
       
    60      * Access the viewfinder control.
       
    61      */
       
    62     virtual CxeViewfinderControl &viewfinderControl() = 0;
       
    63 
       
    64     /**
       
    65      * Access the snapshot control.
       
    66      */
       
    67     virtual CxeSnapshotControl &snapshotControl() = 0;
       
    68 
       
    69     /**
       
    70      * Access the still capture control.
       
    71      */
       
    72     virtual CxeStillCaptureControl &stillCaptureControl() = 0;
       
    73 
       
    74     /**
       
    75      * Access the video capture control.
       
    76      */
       
    77     virtual CxeVideoCaptureControl &videoCaptureControl() = 0;
       
    78 
       
    79     /**
       
    80      * Access the auto-focus control.
       
    81      */
       
    82     virtual CxeAutoFocusControl &autoFocusControl() = 0;
       
    83 
       
    84     /**
       
    85      * Access the zoom control.
       
    86      */
       
    87     virtual CxeZoomControl &zoomControl() = 0;
       
    88 
       
    89     /**
       
    90      * Access the settings model.
       
    91      */
       
    92     virtual CxeSettings &settings() = 0;
       
    93 
       
    94     /**
       
    95      * Access the feature manager.
       
    96      */
       
    97     virtual CxeFeatureManager &featureManager() = 0;
       
    98 
       
    99     /**
       
   100      * Memory monitor utility.
       
   101      */
       
   102     virtual CxeMemoryMonitor &memoryMonitor() = 0;
       
   103     
       
   104     /**
       
   105      * Geotagging trail utility.
       
   106      */
       
   107     virtual CxeGeoTaggingTrail &geoTaggingTrail() = 0;
       
   108     
       
   109     /**
       
   110      * Get current camera mode.
       
   111      */
       
   112     virtual Cxe::CameraMode mode() const = 0;
       
   113 
       
   114     /**
       
   115      * Set current camera mode.
       
   116      */
       
   117     virtual void setMode(Cxe::CameraMode mode) = 0;
       
   118 
       
   119     /**
       
   120      * Initialize the camera in either still or video mode. This method is also
       
   121      * used to switch between modes.
       
   122      */
       
   123     virtual void initMode( Cxe::CameraMode cameraMode ) = 0;
       
   124 
       
   125     //! returns if the engine is ready or not
       
   126     virtual bool isEngineReady() = 0;
       
   127 
       
   128 protected:
       
   129     CxeEngine();
       
   130 
       
   131 private:
       
   132     Q_DISABLE_COPY( CxeEngine )
       
   133 };
       
   134 
       
   135 #endif // CXEENGINE_H