os/mm/mmlibs/mmfw/inc/Mda/Client/Utility.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mmlibs/mmfw/inc/Mda/Client/Utility.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,121 @@
     1.4 +// Copyright (c) 1997-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 +// Mda\Client\Utility.h
    1.18 +// maintained for backwards compatibility
    1.19 +// 
    1.20 +//
    1.21 +
    1.22 +
    1.23 +#ifndef __MDA_CLIENT_UTILITY_H__
    1.24 +#define __MDA_CLIENT_UTILITY_H__
    1.25 +
    1.26 +// Standard EPOC32 includes
    1.27 +#include <e32base.h>
    1.28 +#include <mda/common/base.h>
    1.29 +
    1.30 +/**
    1.31 +@publishedAll
    1.32 +@removed
    1.33 +*/
    1.34 +enum {
    1.35 +	KDummyMdaServerNotImplemented
    1.36 +	};
    1.37 +
    1.38 +// Maintained for backwards compatibility
    1.39 +// Some code such as CONE uses constucts such as CMdaServer* iServer = CMdaServer::NewL();
    1.40 +
    1.41 +/**
    1.42 +@publishedAll
    1.43 +@deprecated
    1.44 +
    1.45 +This class has been deprecated in 7.0s.
    1.46 +*/
    1.47 +class MMdaObjectEventListener
    1.48 +	{
    1.49 +public:
    1.50 +
    1.51 +	/**
    1.52 +    Handles an event that occurred in the media server. Called by the CMdaServer object that the listener has been added to.
    1.53 +
    1.54 +	@param  aEvent
    1.55 +	        A single event that occurred in the media server.
    1.56 +	
    1.57 +	@see CMdaServer::AddListenerL()
    1.58 +	*/
    1.59 +	virtual void MoelEvent(const TMdaEvent& aEvent) =0;
    1.60 +
    1.61 +	/**
    1.62 +    This function, rather than MoelEvent() is called if the event's ID is EMdaEventMissed. Events are stored when they are 
    1.63 +	received and a missed event occurs when there are no spare slots.
    1.64 +	*/
    1.65 +	virtual void MoelEventMissed() =0;
    1.66 +	friend class CMdaServer;
    1.67 +	};
    1.68 +
    1.69 +/**
    1.70 +@publishedAll
    1.71 +@deprecated
    1.72 +
    1.73 +This class has been deprecated in 7.0s.
    1.74 +*/
    1.75 +class CMdaServer : public CBase
    1.76 +	{
    1.77 +public:
    1.78 +	IMPORT_C static CMdaServer* NewL();
    1.79 +	IMPORT_C ~CMdaServer();
    1.80 +	IMPORT_C void AddListenerL(MMdaObjectEventListener& aListener);
    1.81 +	IMPORT_C void RemoveListener(MMdaObjectEventListener& aListener);
    1.82 +	};
    1.83 +
    1.84 +/**
    1.85 +@publishedAll
    1.86 +@released
    1.87 +
    1.88 +An interface class for handling the change of state of an audio data sample object.
    1.89 +
    1.90 +The class is a mixin and is intended to be inherited by the client class which is observing the audio recording or the 
    1.91 +audio conversion operation. The class defines a single function which must be implemented by the inheriting client class.
    1.92 +
    1.93 +This class is maintained for binary compatibility with versions prior to 7.0s.
    1.94 +
    1.95 +Defined in MMdaObjectStateChangeObserver:
    1.96 +MoscoStateChangeEvent()
    1.97 +*/
    1.98 +class MMdaObjectStateChangeObserver
    1.99 +	{
   1.100 +public:
   1.101 +	/**
   1.102 +	This method is used to receive the updated state of an audio data sample object.  This method must be implemented 
   1.103 +	by the inheriting client class.
   1.104 +
   1.105 +	@param aObject
   1.106 +		   The audio data sample object whose state has changed.
   1.107 +
   1.108 +	@param aPreviousState
   1.109 +		   This is the previous state of the audio data sample object before it went into the current state.  
   1.110 +		   It is expected to be one of the enum values defined in CMdaAudioClipUtility::TState, which defines 
   1.111 +		   the possible states of an audio data sample.
   1.112 +
   1.113 +	@param aCurrentState
   1.114 +		   This is the current state of the audio data sample object.  It is expected to be one of the enum values defined 
   1.115 +		   in CMdaAudioClipUtility::TState, which defines the possible states of an audio data sample.
   1.116 +			
   1.117 +	@param aErrorCode
   1.118 +		   A system wide error code, KErrNone for sucessful completion.  KErrInUse, KErrDied or KErrAccessDenied 
   1.119 +		   may be returned to indicate that the sound device is in use  by another higher priority client.
   1.120 +	 */
   1.121 +	virtual void MoscoStateChangeEvent(CBase* aObject, TInt aPreviousState, TInt aCurrentState, TInt aErrorCode)=0;
   1.122 +	};
   1.123 +
   1.124 +#endif