epoc32/include/mda/client/utility.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mda/client/utility.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mda/client/utility.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,121 @@
     1.4 -utility.h
     1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +// Mda\Client\Utility.h
    1.19 +// maintained for backwards compatibility
    1.20 +// 
    1.21 +//
    1.22 +
    1.23 +
    1.24 +#ifndef __MDA_CLIENT_UTILITY_H__
    1.25 +#define __MDA_CLIENT_UTILITY_H__
    1.26 +
    1.27 +// Standard EPOC32 includes
    1.28 +#include <e32base.h>
    1.29 +#include <mda/common/base.h>
    1.30 +
    1.31 +/**
    1.32 +@publishedAll
    1.33 +@removed
    1.34 +*/
    1.35 +enum {
    1.36 +	KDummyMdaServerNotImplemented
    1.37 +	};
    1.38 +
    1.39 +// Maintained for backwards compatibility
    1.40 +// Some code such as CONE uses constucts such as CMdaServer* iServer = CMdaServer::NewL();
    1.41 +
    1.42 +/**
    1.43 +@publishedAll
    1.44 +@deprecated
    1.45 +
    1.46 +This class has been deprecated in 7.0s.
    1.47 +*/
    1.48 +class MMdaObjectEventListener
    1.49 +	{
    1.50 +public:
    1.51 +
    1.52 +	/**
    1.53 +    Handles an event that occurred in the media server. Called by the CMdaServer object that the listener has been added to.
    1.54 +
    1.55 +	@param  aEvent
    1.56 +	        A single event that occurred in the media server.
    1.57 +	
    1.58 +	@see CMdaServer::AddListenerL()
    1.59 +	*/
    1.60 +	virtual void MoelEvent(const TMdaEvent& aEvent) =0;
    1.61 +
    1.62 +	/**
    1.63 +    This function, rather than MoelEvent() is called if the event's ID is EMdaEventMissed. Events are stored when they are 
    1.64 +	received and a missed event occurs when there are no spare slots.
    1.65 +	*/
    1.66 +	virtual void MoelEventMissed() =0;
    1.67 +	friend class CMdaServer;
    1.68 +	};
    1.69 +
    1.70 +/**
    1.71 +@publishedAll
    1.72 +@deprecated
    1.73 +
    1.74 +This class has been deprecated in 7.0s.
    1.75 +*/
    1.76 +class CMdaServer : public CBase
    1.77 +	{
    1.78 +public:
    1.79 +	IMPORT_C static CMdaServer* NewL();
    1.80 +	IMPORT_C ~CMdaServer();
    1.81 +	IMPORT_C void AddListenerL(MMdaObjectEventListener& aListener);
    1.82 +	IMPORT_C void RemoveListener(MMdaObjectEventListener& aListener);
    1.83 +	};
    1.84 +
    1.85 +/**
    1.86 +@publishedAll
    1.87 +@released
    1.88 +
    1.89 +An interface class for handling the change of state of an audio data sample object.
    1.90 +
    1.91 +The class is a mixin and is intended to be inherited by the client class which is observing the audio recording or the 
    1.92 +audio conversion operation. The class defines a single function which must be implemented by the inheriting client class.
    1.93 +
    1.94 +This class is maintained for binary compatibility with versions prior to 7.0s.
    1.95 +
    1.96 +Defined in MMdaObjectStateChangeObserver:
    1.97 +MoscoStateChangeEvent()
    1.98 +*/
    1.99 +class MMdaObjectStateChangeObserver
   1.100 +	{
   1.101 +public:
   1.102 +	/**
   1.103 +	This method is used to receive the updated state of an audio data sample object.  This method must be implemented 
   1.104 +	by the inheriting client class.
   1.105 +
   1.106 +	@param aObject
   1.107 +		   The audio data sample object whose state has changed.
   1.108 +
   1.109 +	@param aPreviousState
   1.110 +		   This is the previous state of the audio data sample object before it went into the current state.  
   1.111 +		   It is expected to be one of the enum values defined in CMdaAudioClipUtility::TState, which defines 
   1.112 +		   the possible states of an audio data sample.
   1.113 +
   1.114 +	@param aCurrentState
   1.115 +		   This is the current state of the audio data sample object.  It is expected to be one of the enum values defined 
   1.116 +		   in CMdaAudioClipUtility::TState, which defines the possible states of an audio data sample.
   1.117 +			
   1.118 +	@param aErrorCode
   1.119 +		   A system wide error code, KErrNone for sucessful completion.  KErrInUse, KErrDied or KErrAccessDenied 
   1.120 +		   may be returned to indicate that the sound device is in use  by another higher priority client.
   1.121 +	 */
   1.122 +	virtual void MoscoStateChangeEvent(CBase* aObject, TInt aPreviousState, TInt aCurrentState, TInt aErrorCode)=0;
   1.123 +	};
   1.124 +
   1.125 +#endif