Symaptic: os/mm/mm_plat/audio_effects_proxy_api/inc/RoomLevelProxy.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 Room Level proxy class.

    15 *

    16 *

    17 */

    20 #ifndef CROOMLEVELPROXY_H

    21 #define CROOMLEVELPROXY_H

    23 // INCLUDES

    24 #include <e32base.h>

    25 #include <RoomLevelBase.h>

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

    27 #include <CustomCommandUtility.h>

    28 #include "RoomLevelMessageTypes.h"

    29 #include <MRoomLevelObserver.h>

    30 #include <MAudioEffectObserver.h>

    32 // FORWARD DECLARATION

    33 class CRoomLevelEventObserver;

    34 //class CEnvironmentalReverbProxy;

    36 // CLASS DECLARATION

    38 /**

    39 *  Interface class to be implemented by objects that receives callbacks from Room Level Event Observer.

    40 *

    41 *  @since 3.0

    42 */

    43 class MRoomLevelCallback

    44     {

    45     public:

    47         /**

    48         * Invoked by the RoomLevel Event Observer when the RoomLevel object changes state

    49         * @since 3.0

    50         * @param aBuffer Buffer containing the RoomLevel data

    51         */

    52         virtual void RoomLevelEvent( const TDesC8& aDataPckg ) = 0;

    54     };

    56 /**

    57 *  This is the RoomLevel effect proxy class responsible for handling framework messages.

    58 *

    59 *  @lib RoomLevelProxy.lib

    60 *  @since 3.0

    61 */

    63 class CRoomLevelProxy : public CRoomLevel,

    64 					    public MRoomLevelCallback

    65 	{

    66 	public:		// Constructors and destructor

    68 	    /**

    69         *

    70         * Factory function for creating the RoomLevel proxy object.

    71         * @since 3.0

    72         * @param aMessageHandler reference to message handler

    73         * @param aCustomCommand reference to custom command utility

    74         * @return	pointer to a RoomLevel proxy object

    75         */

    76 		IMPORT_C static CRoomLevelProxy* NewL( TMMFMessageDestinationPckg aMessageHandler,

    77                      						        	 MCustomCommand& aCustomCommand,

    78                       						        	 CCustomInterfaceUtility* aCustomInterfaceUtility );

    79 		/**

    80         *

    81         * Destructor

    82         */

    83 		virtual ~CRoomLevelProxy();

    85 	public: // functions from base class

    87 		/**

    88 		* From CAudioEffect

    89         * Apply effect settings

    90         * @since 3.0

    91         */

    92 		IMPORT_C virtual void ApplyL();

    95 	public: // functions from MRoomLevelCallback

    97 		/**

    98 		* From MRoomLevelCallback

    99         * Changes to RoomLevel data has occured

   100         * @since 3.0

   101         * @param aBuffer Buffer containing serialized RoomLevel data

   102         */

   103 		void RoomLevelEvent( const TDesC8& aDataPckg );

   106 		/**

   107 		* Set reverb unique ID

   108         *

   109         * @since 3.0

   110         * @param aReverb A reference to the client reverb object

   111         */

   112 		virtual TInt AttachReverb(CEnvironmentalReverb& aReverb);

   114 		/**

   115 		* Delete related message handler and custom interface

   116         *

   117         * @since 3.0

   118         * @param aReverb A reference to the client reverb object

   119         */

   120 		virtual TInt DettachReverb(CEnvironmentalReverb& aReverb);

   124 	private:

   126 		/**

   127 		* Private C++ constructor for this class.

   128         * @since	3.0

   129         * @param aMessageHandler reference to message handler

   130         * @param aCustomCommand reference to custom command utility

   131         * @return	-

   132         */

   133 		CRoomLevelProxy(TMMFMessageDestinationPckg aMessageHandler, MCustomCommand& aCustomCommand,

   134 					         	  CCustomInterfaceUtility* aCustomInterfaceUtility);

   136 		/**

   137 		* Second phase constructor for this class.

   138         * @since	3.0

   139         * @return -

   140         */

   141 		void ConstructL();

   143 		/**

   144 		* Start the active observer.

   145         * @since	3.0

   146 		* @param -

   147         * @return -

   148         */

   149         void StartObserver();

   153 	private:

   155 		// Pointer to custom command utility

   156 		MCustomCommand* iCustomCommand;

   157 		// Message handler handle

   158 		TMMFMessageDestinationPckg iMessageHandler;

   159 	 	// RoomLevel Event Observer

   160 		CRoomLevelEventObserver* iRoomLevelEventObserver;

   161 		// Pointer to the custom interface utility

   162     	CCustomInterfaceUtility* iCustomInterfaceUtility;

   164 	};

   166 #endif	// of CROOMLEVELPROXY_H

   168 // End of File

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