os/mm/devsoundextensions/effectspresets/StereoWideningUtility/src/TempStereoWidening.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsoundextensions/effectspresets/StereoWideningUtility/src/TempStereoWidening.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,134 @@
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 StereoWidening proxy class.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +#ifndef CTEMPSTEREOWIDENING_H
1.24 +#define CTEMPSTEREOWIDENING_H
1.25 +
1.26 +// INCLUDES
1.27 +
1.28 +#include <e32base.h>
1.29 +#include <StereoWideningBase.h>
1.30 +#include <mmfcontrollerframework.h>
1.31 +
1.32 +/**
1.33 +* This is the StereoWidening effect proxy class responsible for handling framework messages.
1.34 +*
1.35 +* @lib StereoWideningProxy.lib
1.36 +* @since 3.0
1.37 +*/
1.38 +
1.39 +class CTempStereoWidening : public CStereoWidening
1.40 +
1.41 + {
1.42 + public: // Constructors and destructor
1.43 +
1.44 + /**
1.45 + *
1.46 + * Factory function for creating the StereoWidening 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 StereoWidening proxy object
1.51 + */
1.52 + IMPORT_C static CTempStereoWidening* NewL(TInt aLevel, CStereoWidening* aStereoWidening);
1.53 + /**
1.54 + *
1.55 + * Destructor
1.56 + */
1.57 + virtual ~CTempStereoWidening();
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 + * From CAudioEffect
1.70 + * check enable flag
1.71 + * @since 3.0
1.72 + */
1.73 + IMPORT_C virtual TBool IsEnabled() const;
1.74 +
1.75 + /**
1.76 + * Disable the effect
1.77 + * @since 3.0
1.78 + */
1.79 + IMPORT_C virtual void DisableL();
1.80 +
1.81 + /**
1.82 + * Check if the effect is enforced.
1.83 + * @since 3.0
1.84 + * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
1.85 + */
1.86 + IMPORT_C virtual TBool IsEnforced() const;
1.87 +
1.88 + /**
1.89 + * Enable the effect
1.90 + * @since 3.0
1.91 + */
1.92 + IMPORT_C virtual void EnableL();
1.93 +
1.94 + /**
1.95 + * Enforce the effect.
1.96 + * @since 3.0
1.97 + * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
1.98 + */
1.99 + IMPORT_C virtual void EnforceL( TBool aEnforced );
1.100 +
1.101 + /**
1.102 + * Check if this effect object currently has update rights.
1.103 + * A client can lose update rights in some hardware platforms where there are a limited
1.104 + * number of instances of an effect that can exist at the same time. When an effect instance
1.105 + * has lost update rights the user can still change settings, but any calls to Apply the
1.106 + * settings will be deferred until update rights are regained.
1.107 + * @since 3.0
1.108 + * @return ETrue if this object currently has rights to update the settings of this effect,
1.109 + * EFalse otherwise.
1.110 + */
1.111 + IMPORT_C virtual TBool HaveUpdateRights() const;
1.112 +
1.113 + private:
1.114 +
1.115 + /**
1.116 + * Private C++ constructor for this class.
1.117 + * @since 3.0
1.118 + * @param aMessageHandler reference to message handler
1.119 + * @param aCustomCommand reference to custom command utility
1.120 + * @return -
1.121 + */
1.122 + CTempStereoWidening();
1.123 +
1.124 + /**
1.125 + * Second phase constructor for this class.
1.126 + * @since 3.0
1.127 + * @return -
1.128 + */
1.129 + void ConstructL(TInt aLevel,CStereoWidening* aStereoWidening);
1.130 +
1.131 + private:
1.132 + CStereoWidening* iStereoWidening;
1.133 + };
1.134 +
1.135 +#endif // of CTEMPSTEREOWIDENING_H
1.136 +
1.137 +// End of File