Symaptic: os/mm/devsoundextensions/effectspresets/StereoWideningUtility/src/TempStereoWidening.h@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2004 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:   This is the definition of the Audio StereoWidening proxy class.

    15 *

    16 */

    20 #ifndef CTEMPSTEREOWIDENING_H

    21 #define CTEMPSTEREOWIDENING_H

    23 // INCLUDES

    25 #include <e32base.h>

    26 #include <StereoWideningBase.h>

    27 #include <mmfcontrollerframework.h>

    29 /**

    30 *  This is the StereoWidening effect proxy class responsible for handling framework messages.

    31 *

    32 *  @lib StereoWideningProxy.lib

    33 *  @since 3.0

    34 */

    36 class CTempStereoWidening : public CStereoWidening

    38 	{

    39 	public:		// Constructors and destructor

    41 	    /**

    42         *

    43         * Factory function for creating the StereoWidening proxy object.

    44         * @since 3.0

    45         * @param aMessageHandler reference to message handler

    46         * @param aCustomCommand reference to custom command utility

    47         * @return	pointer to a StereoWidening proxy object

    48         */

    49 		IMPORT_C static CTempStereoWidening* NewL(TInt aLevel, CStereoWidening* aStereoWidening);

    50 		/**

    51         *

    52         * Destructor

    53         */

    54 		virtual ~CTempStereoWidening();

    56 	public: // functions from base class

    58 		/**

    59 		* From CAudioEffect

    60         * Apply effect settings

    61         * @since 3.0

    62         */

    63 		IMPORT_C virtual void ApplyL();

    65         /**

    66 		* From CAudioEffect

    67         * check enable flag

    68         * @since 3.0

    69         */

    70 	    IMPORT_C virtual TBool IsEnabled() const;

    72 		/**

    73         * Disable the effect

    74         * @since 3.0

    75         */

    76 		IMPORT_C virtual void DisableL();

    78 		/**

    79         * Check if the effect is enforced.

    80         * @since 3.0

    81         * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced.

    82         */

    83 		IMPORT_C virtual TBool IsEnforced() const;

    85 	    /**

    86         * Enable the effect

    87         * @since 3.0

    88         */

    89 		IMPORT_C virtual void EnableL();

    91 		/**

    92         * Enforce the effect.

    93         * @since 3.0

    94         * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.

    95         */

    96 		IMPORT_C virtual void EnforceL( TBool aEnforced );

    98 		/**

    99         * Check if this effect object currently has update rights.

   100         * A client can lose update rights in some hardware platforms where there are a limited

   101         * number of instances of an effect that can exist at the same time. When an effect instance

   102         * has lost update rights the user can still change settings, but any calls to Apply the

   103         * settings will be deferred until update rights are regained.

   104         * @since 3.0

   105         * @return ETrue if this object currently has rights to update the settings of this effect,

   106         *         EFalse otherwise.

   107         */

   108 		IMPORT_C virtual TBool HaveUpdateRights() const;

   110 	private:

   112 		/**

   113 		* Private C++ constructor for this class.

   114         * @since	3.0

   115         * @param aMessageHandler reference to message handler

   116         * @param aCustomCommand reference to custom command utility

   117         * @return	-

   118         */

   119 		CTempStereoWidening();

   121 		/**

   122 		* Second phase constructor for this class.

   123         * @since	3.0

   124         * @return -

   125         */

   126 		void ConstructL(TInt aLevel,CStereoWidening* aStereoWidening);

   128 	private:

   129 		CStereoWidening* iStereoWidening;

   130 	};

   132 #endif	// of CTEMPSTEREOWIDENING_H

   134 // End of File

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--