Symaptic: os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/playbackstatusci.h@260cb5ec6c19

     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    16 #ifndef PLAYBACKSTATUSCI_H

    17 #define PLAYBACKSTATUSCI_H

    19 #include <e32base.h>

    20 #include <mmf/common/mmfipc.h>

    21 #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

    22 #include <mmf/common/mmfipcserver.h>

    23 #endif

    24 #include <mmf/server/mmfdevsoundcustominterface.h>

    25 #include <mmf/server/mmfdevsoundcustomcommands.h>

    26 #include <mmf/server/devsoundstandardcustominterfaces.h>

    27 #include <mmf/plugin/mmfdevsoundcustominterface.hrh>

    29 /**

    30  @internalComponent

    31  @prototype

    32  @file

    33  */

    34 enum TMMFDevSoundCIPlayBackStatusCommands

    35 	{

    36 	EMMFDevSoundCIPlayBackStatus = 0,

    37 	EMMFDevSoundCIPlayBackStatusReqSyncLossNotification,

    38 	EMMFDevSoundCIPlayBackStatusCancelSyncLossNotification

    39 	};

    42 /**

    43  @internalComponent

    44  @prototype

    45  @file

    46  */

    48 /**

    49  * CMMFPlayBackStatusMux

    50  *

    51  * implementation of the Play back status custom interface pair

    52  */

    53 class CMMFPlayBackStatusMux : public CBase,

    54 			      	          public MMMFDevSoundCustomInterfaceMuxPlugin,

    55 			      	 	      public MMMFPlaybackStatus

    56 	{

    57 public:

    59 	// from MMMFDevSoundCustomInterfaceMuxPlugin

    60 	/**

    61 	Attempt to open the interface.

    62 	@param aInterfaceId

    63 		   The UID of the interface to open.

    64 	@return One of the system wide error codes

    65 	*/

    66 	virtual TInt OpenInterface(TUid aInterfaceId);

    68 	/**

    69 	Equivalent to destructor.  Called to destroy plugin.

    70 	*/

    71 	virtual void Release();

    73 	/**

    74 	Pass destructor key.

    75 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

    76 	@param aDestructorKey

    77 	       The Uid returned by REComSession::CreateImplementationL() or similar

    78 	*/

    79 	virtual void PassDestructorKey(TUid aDestructorKey);

    81 	/**

    82 	Complete construction.

    83 	Pass additional values from the construction phase, used subsequently by the plugin.

    84 	@param aCustomUtility

    85 	       The custom interface utility used by the plugin to communicate with the remote

    86 		   server side DeMux plugin

    87 	@leave This method may leave with one of the system-wide error codes.

    88 	*/

    89 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);

    91 	/**

    92 	Return the custom interface

    93 	@param aInterfaceId

    94 		   The UID of the required custom interface

    95 	@return The custom interface supported by this plugin

    96 	*/

    97 	virtual TAny* CustomInterface(TUid aInterfaceId);

    99 	/**

   100 	Instantiate a CI Mux class

   101 	@leave This method may leave with one of the system-wide error codes.

   102 	@return The pointer to the new class, cast to the Mux plugin mixin

   103 	*/

   104 	static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();

   106 	// from MMMFPlaybackStatus

   107 	/**

   108 	@see MMMFPlaybackStatus

   109 	*/

   110 	virtual TInt MmpsGetPlaybackStatusInformation(TMMFPlaybackStatus& aStatus);

   112 	/**

   113 	@see MMMFPlaybackStatus

   114 	*/

   115 	virtual TInt MmpsRequestLossOfSyncNotification();

   117 	/**

   118 	@see MMMFPlaybackStatus

   119 	*/

   120 	virtual TInt MmpsCancelLossOfSyncNotification();

   122 protected:

   123 	CMMFPlayBackStatusMux();

   124 	~CMMFPlayBackStatusMux();

   126 protected:

   127 	TUid iDestructorKey;

   128 	TInt iRemoteHandle;

   129 	MMMFDevSoundCustomInterfaceMuxUtility* iUtility;

   130 	};

   132 /**

   133  * CMMFPlayBackStatusDeMux

   134  *

   135  * Implementation of the DeMux side of pair

   136  */

   137 class CMMFPlayBackStatusDeMux : public CBase,

   138 			      	   			public MMMFDevSoundCustomInterfaceDeMuxPlugin

   139 	{

   140 public:

   141 	/**

   142 	Instantiate a CMMFPlayBackStatusDeMux class

   143 	@leave This method may leave with one of the system-wide error codes.

   144 	@return A pointer to the new class cast to the DeMux plugin mixin

   145 	*/

   146 	static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();

   148 	/**

   149 	Attempt to open the interface.

   150 	@param aInterfaceId

   151 		   The UID of the interface to open.

   152 	@return A handle to the remote plugin

   153 	*/

   154 	virtual TInt OpenInterface(TUid aInterfaceId);

   156 	/**

   157 	Equivalent to destructor.  Called to destroy plugin.

   158 	*/

   159 	virtual void Release();

   160 	/**

   161 	Pass destructor key.

   162 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

   163 	@param aDestructorKey

   164 	       The Uid returned by REComSession::CreateImplementationL() or similar

   165 	*/

   166 	virtual void PassDestructorKey(TUid aDestructorKey);

   168 	/**

   169 	Set the target of the custom interface call

   170 	@param aTarget

   171 	       The DevSound to call the custom interface on.

   172 	*/

   173 	virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);

   175 	/**

   176 	Complete construction.

   177 	@param aUtility

   178 			The DeMux utility to use

   179 	@leave This method may leave with one of the system-wide error codes.

   180 	*/

   181 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);

   183 	/**

   184 	Refresh the current custom interface connections

   185 	@leave This method may leave with one of the system-wide error codes.

   186 	*/

   187 	virtual void RefreshL();

   189 	// from MMMFDevSoundCustomInterfaceDeMuxPlugin

   190 	/**

   191 	Open the slave

   192 	@param aInterface

   193 		   The UID of the requested interface

   194 	@param aPackageBuf

   195 		   A package of data that can be supplied for initialisation

   196 	@leave This method may leave with one of the system-wide error codes.

   197 	@return The result of the operation

   198 	*/

   199 	virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);

   201 	/**

   202 	Close the slave

   203 	@param aHandle

   204 		   The handle of the slave plugin

   205 	@leave This method may leave with one of the system-wide error codes.

   206 	*/

   207 	virtual void DoCloseSlaveL(TInt aHandle);

   209 	// original RMessage is supplied so that remote demux plugin can extract necessary details

   210 	// using DeMux utility

   212 	/**

   213 	Relay the synchronous custom command onto the slave

   214 	@param aMessage

   215 		   The IPC message to be sent to the slave

   216 	@leave This method may leave with one of the system-wide error codes.

   217 	@return The result of the operation

   218 	*/

   219 	virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);

   221 	/**

   222 	Relay the synchronous custom command onto the slave and obtain a result

   223 	@param aMessage

   224 		   The IPC message to be sent to the slave

   225 	@leave This method may leave with one of the system-wide error codes.

   226 	@return The result of the operation

   227 	*/

   228 	virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);

   230 	/**

   231 	Relay an asynchronous command onto the slave

   232 	@param aMessage

   233 		   The IPC message to be sent to the slave

   234 	@leave This method may leave with one of the system-wide error codes.

   235 	*/

   236 	virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);

   238 	/**

   239 	Relay an asynchronous command onto the slave and obtain a result

   240 	@param aMessage

   241 		   The IPC message to be sent to the slave@param aMessage

   242 	@leave This method may leave with one of the system-wide error codes.

   243 	*/

   244 	virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);

   246 protected:

   247 	~CMMFPlayBackStatusDeMux();

   248 	CMMFPlayBackStatusDeMux();

   250 	// from mirror MMMFPlaybackStatus method.

   251 	TInt DoMmpsGetPlaybackStatusInformation(MMMFPlaybackStatus::TMMFPlaybackStatus& aStatus);

   252 	TInt DoMmpsRequestLossOfSyncNotification();

   253 	TInt DoMmpsCancelLossOfSyncNotification();

   255 protected:

   256 	MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;

   257 	MMMFDevSoundCustomInterfaceTarget* iTarget;

   258 	TUid iDestructorKey;

   259 	MMMFPlaybackStatus* iInterfacePlayBackStatus;

   260 	};

   262 #endif

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