mmsharing/livecommsui/lcuiengine/inc/lcuiengine.h
branchRCL_3
changeset 33 bc78a40cd63c
parent 32 73a1feb507fb
child 35 6c57ef9392d2
equal deleted inserted replaced
32:73a1feb507fb 33:bc78a40cd63c
     1 /*
       
     2 * Copyright (c) 2009 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 LCUIENGINE_H
       
    18 #define LCUIENGINE_H
       
    19 
       
    20 //USER
       
    21 
       
    22 //SYSTEM
       
    23 #include <QObject>
       
    24 #include <QString>
       
    25 #include <QTime>
       
    26 
       
    27 class QTimer;
       
    28 class HbProgressDialog;
       
    29 class HbDialog;
       
    30 class QRectF;
       
    31 class LcUiEnginePrivate;
       
    32 class HbView;
       
    33 
       
    34 const char lcEngSignalNameMuted[] = "muted";
       
    35 const char lcEngSignalNameUnmuted[] = "unmuted";
       
    36 const char lcEngSignalNameSpeakerEnabled[] = "speakerEnabled";
       
    37 const char lcEngSignalNameSpeakerDisabled[] = "speakerDisabled";
       
    38 const char lcEngSignalNameCameraChangedToMain[] = "cameraChangedToMain";
       
    39 const char lcEngSignalNameCameraChangedToSecondary[] = "cameraChangedToSecondary";
       
    40 const char lcEngSignalNameCameraEnabled[] = "cameraEnabled";
       
    41 const char lcEngSignalNameCameraDisabled[] = "cameraDisabled";
       
    42 
       
    43 
       
    44 /*
       
    45  * Supported views
       
    46  */
       
    47 enum LcViewLayoutHint {
       
    48     Lc_NoViewLayout = -1,
       
    49     Lc_IdleViewLayout,
       
    50     Lc_SharedViewLayout,
       
    51     Lc_ReceivedViewLayout,
       
    52     Lc_ReceivedOnlyViewLayout,
       
    53     Lc_TwowayViewLayout,
       
    54     Lc_AllInOneViewLayout
       
    55 };
       
    56 
       
    57 
       
    58 /*
       
    59  * Struct of values for control
       
    60  */
       
    61 class LcControlValues {
       
    62 public:
       
    63   int mMaxValue;
       
    64   int mMinValue;
       
    65   int mValue;
       
    66 };
       
    67 
       
    68 /*
       
    69  * Live Comms UI Engine 
       
    70  */
       
    71 class LcUiEngine : public QObject
       
    72 {
       
    73     Q_OBJECT
       
    74     friend class UT_LcUiEngine;
       
    75 
       
    76 public:
       
    77     //constructor
       
    78     explicit LcUiEngine(const QString &engineName,
       
    79                         const QString &applicationDisplayName);
       
    80     //destructor
       
    81     ~LcUiEngine();
       
    82     
       
    83 signals:
       
    84   
       
    85     //signaled when engine is stopped
       
    86     void stopped();
       
    87     //signaled when layout is changed
       
    88     void layoutChanged();
       
    89     //signaled when camera changes to main
       
    90     void cameraChangedToMain();
       
    91     //signaled when camera changes to secondary
       
    92     void cameraChangedToSecondary();
       
    93     //signaled when mic is muted
       
    94     void muted();
       
    95     //signaled when mic is unmuted
       
    96     void unmuted();
       
    97     //signaled when speaker is enabled
       
    98     void speakerEnabled();
       
    99     //signaled when speaker is disabled
       
   100     void speakerDisabled();
       
   101     //signaled when camera is disabled
       
   102     void cameraDisabled();
       
   103     //signaled when camera is enabled
       
   104     void cameraEnabled();
       
   105     //signaled when engine is blocked, 
       
   106     //no calls expected until signaled unblocked    
       
   107     void blocked();
       
   108     //signaled when engine is free 
       
   109     void unblocked();
       
   110     //signaled continuously while session is up and running
       
   111     //carries current session duration
       
   112     void sessionDurationChanged(const QString &duration);
       
   113     void recipientChanged(const QString &recipient);
       
   114     void phoneNumberChanged(const QString &number);    
       
   115     //signaled when player state changed
       
   116     void localPlayerPlaying();
       
   117     void remotePlayerPlaying();
       
   118     void localPlayerPreparing();
       
   119     void remotePlayerPreparing();
       
   120     void localPlayerBuffering();
       
   121     void remotePlayerBuffering();
       
   122     void localPlayerPaused();
       
   123     void remotePlayerPaused();
       
   124     void localPlayerUnavailable();
       
   125     void remotePlayerUnavailable();
       
   126     void volumeChanged(int aVolumeLevel);
       
   127     
       
   128     
       
   129 public slots:
       
   130 
       
   131     void zoom( int value );
       
   132     void stop();
       
   133     void minimize();
       
   134     void maximize();   
       
   135         
       
   136 public: // API
       
   137     
       
   138     void start();
       
   139     const QString& sessionTitle() const;
       
   140     const QString& recipient() const;
       
   141     const QString& phoneNumber() const;
       
   142     LcViewLayoutHint viewLayout() const;
       
   143     void setContentAreas(const QRectF& sharedContent,
       
   144                          const QRectF& receivedContent);
       
   145     bool setOrientation(Qt::Orientation orientation);
       
   146     void setUiComponents(HbProgressDialog* invitingNote,
       
   147                          HbProgressDialog* waitingNote,
       
   148                          HbDialog* acceptQuery,
       
   149                          HbDialog* recipientQuery,
       
   150                          HbDialog* shareOwnVideoQuery);
       
   151     void toggleMute();
       
   152     bool isMuted() const;
       
   153     void toggleSpeaker();
       
   154     bool isSpeakerOn() const;
       
   155     int zoomValues(LcControlValues& values) const;
       
   156     void toggleDisableCamera();
       
   157     void setMainCamera(const bool aMainCamera);
       
   158     bool mainCamera() const;
       
   159     void toggleCamera();
       
   160     bool fullScreenMode();
       
   161     void setFullScreenMode(bool aMode);
       
   162     void updateSession();
       
   163     bool isLocalPlayerPlaying() const;
       
   164     bool isRemotePlayerPlaying() const;
       
   165     bool isMinimized()const;
       
   166     bool isMaximized()const{return !isMinimized();}; 
       
   167     void shareImage(const QString&);
       
   168     void shareCamera();
       
   169     void setCurrentView(HbView* view);
       
   170     bool SendDialTone( const QChar aKey );
       
   171 
       
   172 private:
       
   173 
       
   174     LcUiEnginePrivate* d;
       
   175 
       
   176 friend class LcUiEnginePrivate; // access to signals
       
   177 };
       
   178 
       
   179 #endif // LCUIENGINE_H
       
   180 
       
   181 
       
   182 // End of file