os/mm/devsoundextensions/effectspresets/AudioEqualizerUtility/src/TempAudioEqualizer.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     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 Equalizer proxy class.
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef CTEMPAUDIOEQUALIZER_H
    21 #define CTEMPAUDIOEQUALIZER_H
    22 
    23 // INCLUDES
    24 
    25 #include <e32base.h>
    26 #include <AudioEqualizerBase.h>
    27 #include <mmfcontrollerframework.h>
    28 
    29 /**
    30 *  This is the AudioEqualizer effect proxy class responsible for handling framework messages.
    31 *
    32 *  @lib AudioEqualizerProxy.lib
    33 *  @since 3.0
    34 */
    35 
    36 class CTempAudioEqualizer : public CAudioEqualizer
    37 
    38 	{
    39 	public:		// Constructors and destructor
    40 
    41 	    /**
    42         *
    43         * Factory function for creating the AudioEqualizer 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 AudioEqualizer proxy object
    48         */
    49 		IMPORT_C static CTempAudioEqualizer* NewL(TInt aNumberOfBands, CAudioEqualizer* aAudioEqualizer);
    50 		/**
    51         *
    52         * Destructor
    53         */
    54 		virtual ~CTempAudioEqualizer();
    55 
    56 	public: // functions from base class
    57 
    58 		/**
    59 		* From CAudioEffect
    60         * Apply effect settings
    61         * @since 3.0
    62         */
    63 		IMPORT_C virtual void ApplyL();
    64 
    65 
    66 	/**
    67 		* From CAudioEffect
    68         * check enable flag
    69         * @since 3.0
    70         */
    71 	    IMPORT_C virtual TBool IsEnabled() const;
    72 	
    73 		/**
    74         * Disable the effect
    75         * @since 3.0
    76         */
    77 		IMPORT_C virtual void DisableL();
    78 	
    79 		/**
    80         * Check if the effect is enforced.
    81         * @since 3.0
    82         * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
    83         */
    84 		IMPORT_C virtual TBool IsEnforced() const;
    85 
    86 	    /**
    87         * Enable the effect
    88         * @since 3.0
    89         */
    90 		IMPORT_C virtual void EnableL();
    91 
    92 		/**
    93         * Enforce the effect.
    94         * @since 3.0
    95         * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
    96         */
    97 		IMPORT_C virtual void EnforceL( TBool aEnforced );
    98 	
    99 		/**
   100         * Check if this effect object currently has update rights.
   101         * A client can lose update rights in some hardware platforms where there are a limited
   102         * number of instances of an effect that can exist at the same time. When an effect instance
   103         * has lost update rights the user can still change settings, but any calls to Apply the
   104         * settings will be deferred until update rights are regained.
   105         * @since 3.0
   106         * @return ETrue if this object currently has rights to update the settings of this effect,
   107         *         EFalse otherwise.
   108         */
   109 		IMPORT_C virtual TBool HaveUpdateRights() const;
   110 		
   111 		
   112 	private:
   113 
   114 		/**
   115 		* Private C++ constructor for this class.
   116         * @since	3.0
   117         * @param aMessageHandler reference to message handler
   118         * @param aCustomCommand reference to custom command utility
   119         * @return	-
   120         */
   121 		CTempAudioEqualizer();
   122 
   123 		/**
   124 		* Second phase constructor for this class.
   125         * @since	3.0
   126         * @return -
   127         */
   128 		void ConstructL(TInt aNumberOfBands,CAudioEqualizer* aAudioEqualizer);
   129 
   130 	private:
   131 		CAudioEqualizer* iAudioEqualizer;
   132 		TInt iNumberOfBands;
   133 	};
   134 
   135 #endif	// of CTEMPAUDIOEQUALIZER_H
   136 
   137 // End of File