os/mm/devsoundextensions/effectspresets/AudioEqualizerUtility/src/TempAudioEqualizer.h
First public contribution.
2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
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".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
14 * Description: This is the definition of the Audio Equalizer proxy class.
20 #ifndef CTEMPAUDIOEQUALIZER_H
21 #define CTEMPAUDIOEQUALIZER_H
26 #include <AudioEqualizerBase.h>
27 #include <mmfcontrollerframework.h>
30 * This is the AudioEqualizer effect proxy class responsible for handling framework messages.
32 * @lib AudioEqualizerProxy.lib
36 class CTempAudioEqualizer : public CAudioEqualizer
39 public: // Constructors and destructor
43 * Factory function for creating the AudioEqualizer proxy object.
45 * @param aMessageHandler reference to message handler
46 * @param aCustomCommand reference to custom command utility
47 * @return pointer to a AudioEqualizer proxy object
49 IMPORT_C static CTempAudioEqualizer* NewL(TInt aNumberOfBands, CAudioEqualizer* aAudioEqualizer);
54 virtual ~CTempAudioEqualizer();
56 public: // functions from base class
60 * Apply effect settings
63 IMPORT_C virtual void ApplyL();
71 IMPORT_C virtual TBool IsEnabled() const;
77 IMPORT_C virtual void DisableL();
80 * Check if the effect is enforced.
82 * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
84 IMPORT_C virtual TBool IsEnforced() const;
90 IMPORT_C virtual void EnableL();
95 * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
97 IMPORT_C virtual void EnforceL( TBool aEnforced );
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.
106 * @return ETrue if this object currently has rights to update the settings of this effect,
109 IMPORT_C virtual TBool HaveUpdateRights() const;
115 * Private C++ constructor for this class.
117 * @param aMessageHandler reference to message handler
118 * @param aCustomCommand reference to custom command utility
121 CTempAudioEqualizer();
124 * Second phase constructor for this class.
128 void ConstructL(TInt aNumberOfBands,CAudioEqualizer* aAudioEqualizer);
131 CAudioEqualizer* iAudioEqualizer;
135 #endif // of CTEMPAUDIOEQUALIZER_H