diff -r 000000000000 -r b8ed18f6c07b devsoundextensions/effectspresets/AudioEqualizerUtility/src/TempAudioEqualizer.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/devsoundextensions/effectspresets/AudioEqualizerUtility/src/TempAudioEqualizer.h Thu Oct 07 22:34:12 2010 +0100 @@ -0,0 +1,137 @@ +/* +* Copyright (c) 2004 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 is the definition of the Audio Equalizer proxy class. +* +*/ + + + +#ifndef CTEMPAUDIOEQUALIZER_H +#define CTEMPAUDIOEQUALIZER_H + +// INCLUDES + +#include +#include +#include + +/** +* This is the AudioEqualizer effect proxy class responsible for handling framework messages. +* +* @lib AudioEqualizerProxy.lib +* @since 3.0 +*/ + +class CTempAudioEqualizer : public CAudioEqualizer + + { + public: // Constructors and destructor + + /** + * + * Factory function for creating the AudioEqualizer proxy object. + * @since 3.0 + * @param aMessageHandler reference to message handler + * @param aCustomCommand reference to custom command utility + * @return pointer to a AudioEqualizer proxy object + */ + IMPORT_C static CTempAudioEqualizer* NewL(TInt aNumberOfBands, CAudioEqualizer* aAudioEqualizer); + /** + * + * Destructor + */ + virtual ~CTempAudioEqualizer(); + + public: // functions from base class + + /** + * From CAudioEffect + * Apply effect settings + * @since 3.0 + */ + IMPORT_C virtual void ApplyL(); + + + /** + * From CAudioEffect + * check enable flag + * @since 3.0 + */ + IMPORT_C virtual TBool IsEnabled() const; + + /** + * Disable the effect + * @since 3.0 + */ + IMPORT_C virtual void DisableL(); + + /** + * Check if the effect is enforced. + * @since 3.0 + * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced. + */ + IMPORT_C virtual TBool IsEnforced() const; + + /** + * Enable the effect + * @since 3.0 + */ + IMPORT_C virtual void EnableL(); + + /** + * Enforce the effect. + * @since 3.0 + * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced. + */ + IMPORT_C virtual void EnforceL( TBool aEnforced ); + + /** + * Check if this effect object currently has update rights. + * A client can lose update rights in some hardware platforms where there are a limited + * number of instances of an effect that can exist at the same time. When an effect instance + * has lost update rights the user can still change settings, but any calls to Apply the + * settings will be deferred until update rights are regained. + * @since 3.0 + * @return ETrue if this object currently has rights to update the settings of this effect, + * EFalse otherwise. + */ + IMPORT_C virtual TBool HaveUpdateRights() const; + + + private: + + /** + * Private C++ constructor for this class. + * @since 3.0 + * @param aMessageHandler reference to message handler + * @param aCustomCommand reference to custom command utility + * @return - + */ + CTempAudioEqualizer(); + + /** + * Second phase constructor for this class. + * @since 3.0 + * @return - + */ + void ConstructL(TInt aNumberOfBands,CAudioEqualizer* aAudioEqualizer); + + private: + CAudioEqualizer* iAudioEqualizer; + TInt iNumberOfBands; + }; + +#endif // of CTEMPAUDIOEQUALIZER_H + +// End of File