os/mm/devsoundextensions/effectspresets/AudioEqualizerUtility/src/TempAudioEqualizer.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsoundextensions/effectspresets/AudioEqualizerUtility/src/TempAudioEqualizer.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,137 @@
1.4 +/*
1.5 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description: This is the definition of the Audio Equalizer proxy class.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +#ifndef CTEMPAUDIOEQUALIZER_H
1.24 +#define CTEMPAUDIOEQUALIZER_H
1.25 +
1.26 +// INCLUDES
1.27 +
1.28 +#include <e32base.h>
1.29 +#include <AudioEqualizerBase.h>
1.30 +#include <mmfcontrollerframework.h>
1.31 +
1.32 +/**
1.33 +* This is the AudioEqualizer effect proxy class responsible for handling framework messages.
1.34 +*
1.35 +* @lib AudioEqualizerProxy.lib
1.36 +* @since 3.0
1.37 +*/
1.38 +
1.39 +class CTempAudioEqualizer : public CAudioEqualizer
1.40 +
1.41 + {
1.42 + public: // Constructors and destructor
1.43 +
1.44 + /**
1.45 + *
1.46 + * Factory function for creating the AudioEqualizer proxy object.
1.47 + * @since 3.0
1.48 + * @param aMessageHandler reference to message handler
1.49 + * @param aCustomCommand reference to custom command utility
1.50 + * @return pointer to a AudioEqualizer proxy object
1.51 + */
1.52 + IMPORT_C static CTempAudioEqualizer* NewL(TInt aNumberOfBands, CAudioEqualizer* aAudioEqualizer);
1.53 + /**
1.54 + *
1.55 + * Destructor
1.56 + */
1.57 + virtual ~CTempAudioEqualizer();
1.58 +
1.59 + public: // functions from base class
1.60 +
1.61 + /**
1.62 + * From CAudioEffect
1.63 + * Apply effect settings
1.64 + * @since 3.0
1.65 + */
1.66 + IMPORT_C virtual void ApplyL();
1.67 +
1.68 +
1.69 + /**
1.70 + * From CAudioEffect
1.71 + * check enable flag
1.72 + * @since 3.0
1.73 + */
1.74 + IMPORT_C virtual TBool IsEnabled() const;
1.75 +
1.76 + /**
1.77 + * Disable the effect
1.78 + * @since 3.0
1.79 + */
1.80 + IMPORT_C virtual void DisableL();
1.81 +
1.82 + /**
1.83 + * Check if the effect is enforced.
1.84 + * @since 3.0
1.85 + * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
1.86 + */
1.87 + IMPORT_C virtual TBool IsEnforced() const;
1.88 +
1.89 + /**
1.90 + * Enable the effect
1.91 + * @since 3.0
1.92 + */
1.93 + IMPORT_C virtual void EnableL();
1.94 +
1.95 + /**
1.96 + * Enforce the effect.
1.97 + * @since 3.0
1.98 + * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
1.99 + */
1.100 + IMPORT_C virtual void EnforceL( TBool aEnforced );
1.101 +
1.102 + /**
1.103 + * Check if this effect object currently has update rights.
1.104 + * A client can lose update rights in some hardware platforms where there are a limited
1.105 + * number of instances of an effect that can exist at the same time. When an effect instance
1.106 + * has lost update rights the user can still change settings, but any calls to Apply the
1.107 + * settings will be deferred until update rights are regained.
1.108 + * @since 3.0
1.109 + * @return ETrue if this object currently has rights to update the settings of this effect,
1.110 + * EFalse otherwise.
1.111 + */
1.112 + IMPORT_C virtual TBool HaveUpdateRights() const;
1.113 +
1.114 +
1.115 + private:
1.116 +
1.117 + /**
1.118 + * Private C++ constructor for this class.
1.119 + * @since 3.0
1.120 + * @param aMessageHandler reference to message handler
1.121 + * @param aCustomCommand reference to custom command utility
1.122 + * @return -
1.123 + */
1.124 + CTempAudioEqualizer();
1.125 +
1.126 + /**
1.127 + * Second phase constructor for this class.
1.128 + * @since 3.0
1.129 + * @return -
1.130 + */
1.131 + void ConstructL(TInt aNumberOfBands,CAudioEqualizer* aAudioEqualizer);
1.132 +
1.133 + private:
1.134 + CAudioEqualizer* iAudioEqualizer;
1.135 + TInt iNumberOfBands;
1.136 + };
1.137 +
1.138 +#endif // of CTEMPAUDIOEQUALIZER_H
1.139 +
1.140 +// End of File