1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/playbackstatusci.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,262 @@
1.4 +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef PLAYBACKSTATUSCI_H
1.20 +#define PLAYBACKSTATUSCI_H
1.21 +
1.22 +#include <e32base.h>
1.23 +#include <mmf/common/mmfipc.h>
1.24 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.25 +#include <mmf/common/mmfipcserver.h>
1.26 +#endif
1.27 +#include <mmf/server/mmfdevsoundcustominterface.h>
1.28 +#include <mmf/server/mmfdevsoundcustomcommands.h>
1.29 +#include <mmf/server/devsoundstandardcustominterfaces.h>
1.30 +#include <mmf/plugin/mmfdevsoundcustominterface.hrh>
1.31 +
1.32 +/**
1.33 + @internalComponent
1.34 + @prototype
1.35 + @file
1.36 + */
1.37 +enum TMMFDevSoundCIPlayBackStatusCommands
1.38 + {
1.39 + EMMFDevSoundCIPlayBackStatus = 0,
1.40 + EMMFDevSoundCIPlayBackStatusReqSyncLossNotification,
1.41 + EMMFDevSoundCIPlayBackStatusCancelSyncLossNotification
1.42 + };
1.43 +
1.44 +
1.45 +/**
1.46 + @internalComponent
1.47 + @prototype
1.48 + @file
1.49 + */
1.50 +
1.51 +/**
1.52 + * CMMFPlayBackStatusMux
1.53 + *
1.54 + * implementation of the Play back status custom interface pair
1.55 + */
1.56 +class CMMFPlayBackStatusMux : public CBase,
1.57 + public MMMFDevSoundCustomInterfaceMuxPlugin,
1.58 + public MMMFPlaybackStatus
1.59 + {
1.60 +public:
1.61 +
1.62 + // from MMMFDevSoundCustomInterfaceMuxPlugin
1.63 + /**
1.64 + Attempt to open the interface.
1.65 + @param aInterfaceId
1.66 + The UID of the interface to open.
1.67 + @return One of the system wide error codes
1.68 + */
1.69 + virtual TInt OpenInterface(TUid aInterfaceId);
1.70 +
1.71 + /**
1.72 + Equivalent to destructor. Called to destroy plugin.
1.73 + */
1.74 + virtual void Release();
1.75 +
1.76 + /**
1.77 + Pass destructor key.
1.78 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.79 + @param aDestructorKey
1.80 + The Uid returned by REComSession::CreateImplementationL() or similar
1.81 + */
1.82 + virtual void PassDestructorKey(TUid aDestructorKey);
1.83 +
1.84 + /**
1.85 + Complete construction.
1.86 + Pass additional values from the construction phase, used subsequently by the plugin.
1.87 + @param aCustomUtility
1.88 + The custom interface utility used by the plugin to communicate with the remote
1.89 + server side DeMux plugin
1.90 + @leave This method may leave with one of the system-wide error codes.
1.91 + */
1.92 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);
1.93 +
1.94 + /**
1.95 + Return the custom interface
1.96 + @param aInterfaceId
1.97 + The UID of the required custom interface
1.98 + @return The custom interface supported by this plugin
1.99 + */
1.100 + virtual TAny* CustomInterface(TUid aInterfaceId);
1.101 +
1.102 + /**
1.103 + Instantiate a CI Mux class
1.104 + @leave This method may leave with one of the system-wide error codes.
1.105 + @return The pointer to the new class, cast to the Mux plugin mixin
1.106 + */
1.107 + static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();
1.108 +
1.109 + // from MMMFPlaybackStatus
1.110 + /**
1.111 + @see MMMFPlaybackStatus
1.112 + */
1.113 + virtual TInt MmpsGetPlaybackStatusInformation(TMMFPlaybackStatus& aStatus);
1.114 +
1.115 + /**
1.116 + @see MMMFPlaybackStatus
1.117 + */
1.118 + virtual TInt MmpsRequestLossOfSyncNotification();
1.119 +
1.120 + /**
1.121 + @see MMMFPlaybackStatus
1.122 + */
1.123 + virtual TInt MmpsCancelLossOfSyncNotification();
1.124 +
1.125 +protected:
1.126 + CMMFPlayBackStatusMux();
1.127 + ~CMMFPlayBackStatusMux();
1.128 +
1.129 +protected:
1.130 + TUid iDestructorKey;
1.131 + TInt iRemoteHandle;
1.132 + MMMFDevSoundCustomInterfaceMuxUtility* iUtility;
1.133 + };
1.134 +
1.135 +/**
1.136 + * CMMFPlayBackStatusDeMux
1.137 + *
1.138 + * Implementation of the DeMux side of pair
1.139 + */
1.140 +class CMMFPlayBackStatusDeMux : public CBase,
1.141 + public MMMFDevSoundCustomInterfaceDeMuxPlugin
1.142 + {
1.143 +public:
1.144 + /**
1.145 + Instantiate a CMMFPlayBackStatusDeMux class
1.146 + @leave This method may leave with one of the system-wide error codes.
1.147 + @return A pointer to the new class cast to the DeMux plugin mixin
1.148 + */
1.149 + static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();
1.150 +
1.151 + /**
1.152 + Attempt to open the interface.
1.153 + @param aInterfaceId
1.154 + The UID of the interface to open.
1.155 + @return A handle to the remote plugin
1.156 + */
1.157 + virtual TInt OpenInterface(TUid aInterfaceId);
1.158 +
1.159 + /**
1.160 + Equivalent to destructor. Called to destroy plugin.
1.161 + */
1.162 + virtual void Release();
1.163 + /**
1.164 + Pass destructor key.
1.165 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.166 + @param aDestructorKey
1.167 + The Uid returned by REComSession::CreateImplementationL() or similar
1.168 + */
1.169 + virtual void PassDestructorKey(TUid aDestructorKey);
1.170 +
1.171 + /**
1.172 + Set the target of the custom interface call
1.173 + @param aTarget
1.174 + The DevSound to call the custom interface on.
1.175 + */
1.176 + virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);
1.177 +
1.178 + /**
1.179 + Complete construction.
1.180 + @param aUtility
1.181 + The DeMux utility to use
1.182 + @leave This method may leave with one of the system-wide error codes.
1.183 + */
1.184 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);
1.185 +
1.186 + /**
1.187 + Refresh the current custom interface connections
1.188 + @leave This method may leave with one of the system-wide error codes.
1.189 + */
1.190 + virtual void RefreshL();
1.191 +
1.192 + // from MMMFDevSoundCustomInterfaceDeMuxPlugin
1.193 + /**
1.194 + Open the slave
1.195 + @param aInterface
1.196 + The UID of the requested interface
1.197 + @param aPackageBuf
1.198 + A package of data that can be supplied for initialisation
1.199 + @leave This method may leave with one of the system-wide error codes.
1.200 + @return The result of the operation
1.201 + */
1.202 + virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);
1.203 +
1.204 + /**
1.205 + Close the slave
1.206 + @param aHandle
1.207 + The handle of the slave plugin
1.208 + @leave This method may leave with one of the system-wide error codes.
1.209 + */
1.210 + virtual void DoCloseSlaveL(TInt aHandle);
1.211 +
1.212 + // original RMessage is supplied so that remote demux plugin can extract necessary details
1.213 + // using DeMux utility
1.214 +
1.215 + /**
1.216 + Relay the synchronous custom command onto the slave
1.217 + @param aMessage
1.218 + The IPC message to be sent to the slave
1.219 + @leave This method may leave with one of the system-wide error codes.
1.220 + @return The result of the operation
1.221 + */
1.222 + virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);
1.223 +
1.224 + /**
1.225 + Relay the synchronous custom command onto the slave and obtain a result
1.226 + @param aMessage
1.227 + The IPC message to be sent to the slave
1.228 + @leave This method may leave with one of the system-wide error codes.
1.229 + @return The result of the operation
1.230 + */
1.231 + virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);
1.232 +
1.233 + /**
1.234 + Relay an asynchronous command onto the slave
1.235 + @param aMessage
1.236 + The IPC message to be sent to the slave
1.237 + @leave This method may leave with one of the system-wide error codes.
1.238 + */
1.239 + virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);
1.240 +
1.241 + /**
1.242 + Relay an asynchronous command onto the slave and obtain a result
1.243 + @param aMessage
1.244 + The IPC message to be sent to the slave@param aMessage
1.245 + @leave This method may leave with one of the system-wide error codes.
1.246 + */
1.247 + virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);
1.248 +
1.249 +protected:
1.250 + ~CMMFPlayBackStatusDeMux();
1.251 + CMMFPlayBackStatusDeMux();
1.252 +
1.253 + // from mirror MMMFPlaybackStatus method.
1.254 + TInt DoMmpsGetPlaybackStatusInformation(MMMFPlaybackStatus::TMMFPlaybackStatus& aStatus);
1.255 + TInt DoMmpsRequestLossOfSyncNotification();
1.256 + TInt DoMmpsCancelLossOfSyncNotification();
1.257 +
1.258 +protected:
1.259 + MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;
1.260 + MMMFDevSoundCustomInterfaceTarget* iTarget;
1.261 + TUid iDestructorKey;
1.262 + MMMFPlaybackStatus* iInterfacePlayBackStatus;
1.263 + };
1.264 +
1.265 +#endif