javauis/mmapi_akn/baseline/inc/cmmavolumecontrol.h
branchRCL_3
changeset 19 04becd199f91
child 46 4376525cdefb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/javauis/mmapi_akn/baseline/inc/cmmavolumecontrol.h	Tue Apr 27 16:30:29 2010 +0300
@@ -0,0 +1,131 @@
+/*
+* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  This class is used for volume setting
+*
+*/
+
+
+#ifndef CMMAVOLUMECONTROL_H
+#define CMMAVOLUMECONTROL_H
+
+//  INCLUDES
+#include "cmmacontrol.h"
+#include "mmmaplayerstatelistener.h"
+
+// CONSTANS
+_LIT(KMMAVolumeControlName, "VolumeControl");
+const TInt KMMAVolumeMaxLevel = 100;
+
+class CMMAPlayer;
+
+//  CLASS DECLARATION
+/**
+*   This class is used for volume setting
+*
+*
+*/
+
+class CMMAVolumeControl : public CMMAControl,
+        public MMMAPlayerStateListener
+{
+public:
+    static void StaticSetLevelL(CMMAVolumeControl* aVolumeControl,
+                                TInt aLevel);
+    static void StaticGetLevelL(CMMAVolumeControl* aVolumeControl,
+                                TInt* aLevel);
+
+    ~CMMAVolumeControl();
+
+protected:
+    CMMAVolumeControl(CMMAPlayer* aPlayer);
+    void ConstructBaseL();
+
+    /**
+     * Sets the level to player.
+     * @param aLevel Sound level to set.
+     */
+    virtual void DoSetLevelL(TInt aLevel) = 0;
+
+    /**
+     * Get volume level from player.
+     * @return Current level.
+     */
+    virtual TInt DoGetLevelL() = 0;
+
+public: // From CMMAControl
+    const TDesC& ClassName() const;
+
+    /**
+     * Refresh volume control.
+     */
+    void RefreshControl();
+
+public: // From MMMAPlayerStateListener
+    void StateChanged(TInt aState);
+
+
+public: // New methods
+    /**
+     * Adds new volume level to volume control. Actual volume level will
+     * be calculated using all levels added to the control.
+     * @return Index for new level.
+     */
+    IMPORT_C TInt AddLevelL();
+
+    /**
+     * Sets new volume level for certain level index. After level is set
+     * new actual level is calculated and commited to player in derived
+     * class.
+     * @param aLevelIndex Level's index
+     * @param aVolumeLevel New volume level for level index. Level must be
+     * between 0 and 100.
+     */
+    IMPORT_C void SetVolumeLevelL(TInt aLevelIndex,
+                                  TInt aVolumeLevel);
+    void GetVolumeLevelL(TInt aLevelIndex,
+                         TInt* aVolumeLevel);
+
+
+
+private: // New methods
+
+    /**
+     * Refresh volume level, basically set the volume level again.
+     */
+    void RefreshVolume();
+
+    /**
+     * Sets level if player is started and sends java event level
+     * changed.
+     * @param aLevel Sound level to set.
+     */
+    void SetLevelL(TInt aLevel);
+
+    /**
+     * Calculates new overall level using all values in iLevels array.
+     * @return Current level.
+     */
+    TInt CalculateLevel();
+protected: // data
+    CMMAPlayer* iPlayer;
+
+    // Previous level setted to player. Used to check if level is changed.
+    TInt iLevel;
+
+    // Array containing all levels.
+    RArray< TInt > iLevels;
+
+};
+
+#endif // CMMAVOLUMECONTROL_H