os/mm/devsoundextensions/effectspresets/StereoWideningUtility/src/TempStereoWidening.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description:   This is the definition of the Audio StereoWidening proxy class.
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
sl@0
    20
#ifndef CTEMPSTEREOWIDENING_H
sl@0
    21
#define CTEMPSTEREOWIDENING_H
sl@0
    22
sl@0
    23
// INCLUDES
sl@0
    24
sl@0
    25
#include <e32base.h>
sl@0
    26
#include <StereoWideningBase.h>
sl@0
    27
#include <mmfcontrollerframework.h>
sl@0
    28
sl@0
    29
/**
sl@0
    30
*  This is the StereoWidening effect proxy class responsible for handling framework messages.
sl@0
    31
*
sl@0
    32
*  @lib StereoWideningProxy.lib
sl@0
    33
*  @since 3.0
sl@0
    34
*/
sl@0
    35
sl@0
    36
class CTempStereoWidening : public CStereoWidening
sl@0
    37
sl@0
    38
	{
sl@0
    39
	public:		// Constructors and destructor
sl@0
    40
sl@0
    41
	    /**
sl@0
    42
        *
sl@0
    43
        * Factory function for creating the StereoWidening proxy object.
sl@0
    44
        * @since 3.0
sl@0
    45
        * @param aMessageHandler reference to message handler
sl@0
    46
        * @param aCustomCommand reference to custom command utility
sl@0
    47
        * @return	pointer to a StereoWidening proxy object
sl@0
    48
        */
sl@0
    49
		IMPORT_C static CTempStereoWidening* NewL(TInt aLevel, CStereoWidening* aStereoWidening);
sl@0
    50
		/**
sl@0
    51
        *
sl@0
    52
        * Destructor
sl@0
    53
        */
sl@0
    54
		virtual ~CTempStereoWidening();
sl@0
    55
sl@0
    56
	public: // functions from base class
sl@0
    57
sl@0
    58
		/**
sl@0
    59
		* From CAudioEffect
sl@0
    60
        * Apply effect settings
sl@0
    61
        * @since 3.0
sl@0
    62
        */
sl@0
    63
		IMPORT_C virtual void ApplyL();
sl@0
    64
		
sl@0
    65
        /**
sl@0
    66
		* From CAudioEffect
sl@0
    67
        * check enable flag
sl@0
    68
        * @since 3.0
sl@0
    69
        */
sl@0
    70
	    IMPORT_C virtual TBool IsEnabled() const;
sl@0
    71
	
sl@0
    72
		/**
sl@0
    73
        * Disable the effect
sl@0
    74
        * @since 3.0
sl@0
    75
        */
sl@0
    76
		IMPORT_C virtual void DisableL();
sl@0
    77
	
sl@0
    78
		/**
sl@0
    79
        * Check if the effect is enforced.
sl@0
    80
        * @since 3.0
sl@0
    81
        * @return ETrue if the effect is enforced, EFalse if the effect isn ot enforced.
sl@0
    82
        */
sl@0
    83
		IMPORT_C virtual TBool IsEnforced() const;
sl@0
    84
sl@0
    85
	    /**
sl@0
    86
        * Enable the effect
sl@0
    87
        * @since 3.0
sl@0
    88
        */
sl@0
    89
		IMPORT_C virtual void EnableL();
sl@0
    90
sl@0
    91
		/**
sl@0
    92
        * Enforce the effect.
sl@0
    93
        * @since 3.0
sl@0
    94
        * @param aEnforced Indicate the effect is to be enforced or not. ETrue = Enforced.
sl@0
    95
        */
sl@0
    96
		IMPORT_C virtual void EnforceL( TBool aEnforced );
sl@0
    97
	
sl@0
    98
		/**
sl@0
    99
        * Check if this effect object currently has update rights.
sl@0
   100
        * A client can lose update rights in some hardware platforms where there are a limited
sl@0
   101
        * number of instances of an effect that can exist at the same time. When an effect instance
sl@0
   102
        * has lost update rights the user can still change settings, but any calls to Apply the
sl@0
   103
        * settings will be deferred until update rights are regained.
sl@0
   104
        * @since 3.0
sl@0
   105
        * @return ETrue if this object currently has rights to update the settings of this effect,
sl@0
   106
        *         EFalse otherwise.
sl@0
   107
        */
sl@0
   108
		IMPORT_C virtual TBool HaveUpdateRights() const;
sl@0
   109
sl@0
   110
	private:
sl@0
   111
sl@0
   112
		/**
sl@0
   113
		* Private C++ constructor for this class.
sl@0
   114
        * @since	3.0
sl@0
   115
        * @param aMessageHandler reference to message handler
sl@0
   116
        * @param aCustomCommand reference to custom command utility
sl@0
   117
        * @return	-
sl@0
   118
        */
sl@0
   119
		CTempStereoWidening();
sl@0
   120
sl@0
   121
		/**
sl@0
   122
		* Second phase constructor for this class.
sl@0
   123
        * @since	3.0
sl@0
   124
        * @return -
sl@0
   125
        */
sl@0
   126
		void ConstructL(TInt aLevel,CStereoWidening* aStereoWidening);
sl@0
   127
sl@0
   128
	private:
sl@0
   129
		CStereoWidening* iStereoWidening;
sl@0
   130
	};
sl@0
   131
sl@0
   132
#endif	// of CTEMPSTEREOWIDENING_H
sl@0
   133
sl@0
   134
// End of File