Symaptic: os/mm/mm_plat/audio_effects_proxy_api/inc/DistanceAttenuationProxy.h@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     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".

8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  This is the definition of the DistanceAttenuation proxy class.

    15 *

    16 *

    17 */

    20 #ifndef CDISTANCEATTENUATIONPROXY_H

    21 #define CDISTANCEATTENUATIONPROXY_H

    23 // INCLUDES

    25 #include <e32base.h>

    26 #include <DistanceAttenuationBase.h>

    27 #include <mmf/common/mmfcontrollerframework.h>

    28 #include <CustomCommandUtility.h>

    29 #include "DistanceAttenuationMessageTypes.h"

    30 #include <MDistanceAttenuationObserver.h>

    32 // FORWARD DECLARATION

    33 class CDistanceAttenuationEventObserver;

    35 // CLASS DECLARATION

    37 /**

    38 *  Interface class to be implemented by objects that receives callbacks from Distance Attenuation Event Observer.

    39 *

    40 *  @since 3.0

    41 */

    42 class MDistanceAttenuationCallback

    43     {

    44     public:

    46         /**

    47         * Invoked by the DistanceAttenuation Event Observer when the DistanceAttenuation object changes state

    48         * @since 3.0

    49         * @param aBuffer Buffer containing the DistanceAttenuation data

    50         */

    51         virtual void DistanceAttenuationEvent( const TDesC8& aDataPckg ) = 0;

    53     };

    55 /**

    56 *  This is the DistanceAttenuation effect proxy class responsible for handling framework messages.

    57 *

    58 *  @lib DistanceAttenuationProxy.lib

    59 *  @since 3.0

    60 */

    62 class CDistanceAttenuationProxy : public CDistanceAttenuation,

    63 					         public MDistanceAttenuationCallback

    64 	{

    65 	public:		// Constructors and destructor

    67 	    /**

    68         *

    69         * Factory function for creating the DistanceAttenuation proxy object.

    70         * @since 3.0

    71         * @param aMessageHandler reference to message handler

    72         * @param aCustomCommand reference to custom command utility

    73         * @return	pointer to a DistanceAttenuation proxy object

    74         */

    75 		IMPORT_C static CDistanceAttenuationProxy* NewL( TMMFMessageDestinationPckg aMessageHandler,

    76                      						        MCustomCommand& aCustomCommand,

    77                       						        CCustomInterfaceUtility* aCustomInterfaceUtility );

    78 		/**

    79         *

    80         * Destructor

    81         */

    82 		virtual ~CDistanceAttenuationProxy();

    84 	public: // functions from base class

    86 		/**

    87 		* From CAudioEffect

    88         * Apply effect settings

    89         * @since 3.0

    90         */

    91 		IMPORT_C virtual void ApplyL();

    93 	public: // functions from MDistanceAttenuationCallback

    95 		/**

    96 		* From MDistanceAttenuationCallback

    97         * Changes to DistanceAttenuation data has occured

    98         * @since 3.0

    99         * @param aBuffer Buffer containing serialized DistanceAttenuation data

   100         */

   101 		void DistanceAttenuationEvent( const TDesC8& aDataPckg );

   103 	private:

   105 		/**

   106 		* Private C++ constructor for this class.

   107         * @since	3.0

   108         * @param aMessageHandler reference to message handler

   109         * @param aCustomCommand reference to custom command utility

   110         * @return	-

   111         */

   112 		CDistanceAttenuationProxy(TMMFMessageDestinationPckg aMessageHandler, MCustomCommand& aCustomCommand,

   113 					         CCustomInterfaceUtility* aCustomInterfaceUtility);

   115 		/**

   116 		* Second phase constructor for this class.

   117         * @since	3.0

   118         * @return -

   119         */

   120 		void ConstructL();

   122 		/**

   123 		* Start the active observer.

   124         * @since	3.0

   125 		* @param -

   126         * @return -

   127         */

   128         void StartObserver();

   130 	private:

   132 		// Pointer to custom command utility

   133 		MCustomCommand* iCustomCommand;

   134 		// Message handler handle

   135 		TMMFMessageDestinationPckg iMessageHandler;

   136 	 	// DistanceAttenuation Event Observer

   137 		CDistanceAttenuationEventObserver* iDistanceAttenuationEventObserver;

   138 		// Pointer to the custom interface utility

   139     	CCustomInterfaceUtility* iCustomInterfaceUtility;

   143 	};

   145 #endif	// of CDISTANCEATTENUATIONPROXY_H

   147 // End of File

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--