os/mm/mmlibs/mmfw/inc/Mda/Client/Utility.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// Mda\Client\Utility.h
sl@0
    15
// maintained for backwards compatibility
sl@0
    16
// 
sl@0
    17
//
sl@0
    18
sl@0
    19
sl@0
    20
#ifndef __MDA_CLIENT_UTILITY_H__
sl@0
    21
#define __MDA_CLIENT_UTILITY_H__
sl@0
    22
sl@0
    23
// Standard EPOC32 includes
sl@0
    24
#include <e32base.h>
sl@0
    25
#include <mda/common/base.h>
sl@0
    26
sl@0
    27
/**
sl@0
    28
@publishedAll
sl@0
    29
@removed
sl@0
    30
*/
sl@0
    31
enum {
sl@0
    32
	KDummyMdaServerNotImplemented
sl@0
    33
	};
sl@0
    34
sl@0
    35
// Maintained for backwards compatibility
sl@0
    36
// Some code such as CONE uses constucts such as CMdaServer* iServer = CMdaServer::NewL();
sl@0
    37
sl@0
    38
/**
sl@0
    39
@publishedAll
sl@0
    40
@deprecated
sl@0
    41
sl@0
    42
This class has been deprecated in 7.0s.
sl@0
    43
*/
sl@0
    44
class MMdaObjectEventListener
sl@0
    45
	{
sl@0
    46
public:
sl@0
    47
sl@0
    48
	/**
sl@0
    49
    Handles an event that occurred in the media server. Called by the CMdaServer object that the listener has been added to.
sl@0
    50
sl@0
    51
	@param  aEvent
sl@0
    52
	        A single event that occurred in the media server.
sl@0
    53
	
sl@0
    54
	@see CMdaServer::AddListenerL()
sl@0
    55
	*/
sl@0
    56
	virtual void MoelEvent(const TMdaEvent& aEvent) =0;
sl@0
    57
sl@0
    58
	/**
sl@0
    59
    This function, rather than MoelEvent() is called if the event's ID is EMdaEventMissed. Events are stored when they are 
sl@0
    60
	received and a missed event occurs when there are no spare slots.
sl@0
    61
	*/
sl@0
    62
	virtual void MoelEventMissed() =0;
sl@0
    63
	friend class CMdaServer;
sl@0
    64
	};
sl@0
    65
sl@0
    66
/**
sl@0
    67
@publishedAll
sl@0
    68
@deprecated
sl@0
    69
sl@0
    70
This class has been deprecated in 7.0s.
sl@0
    71
*/
sl@0
    72
class CMdaServer : public CBase
sl@0
    73
	{
sl@0
    74
public:
sl@0
    75
	IMPORT_C static CMdaServer* NewL();
sl@0
    76
	IMPORT_C ~CMdaServer();
sl@0
    77
	IMPORT_C void AddListenerL(MMdaObjectEventListener& aListener);
sl@0
    78
	IMPORT_C void RemoveListener(MMdaObjectEventListener& aListener);
sl@0
    79
	};
sl@0
    80
sl@0
    81
/**
sl@0
    82
@publishedAll
sl@0
    83
@released
sl@0
    84
sl@0
    85
An interface class for handling the change of state of an audio data sample object.
sl@0
    86
sl@0
    87
The class is a mixin and is intended to be inherited by the client class which is observing the audio recording or the 
sl@0
    88
audio conversion operation. The class defines a single function which must be implemented by the inheriting client class.
sl@0
    89
sl@0
    90
This class is maintained for binary compatibility with versions prior to 7.0s.
sl@0
    91
sl@0
    92
Defined in MMdaObjectStateChangeObserver:
sl@0
    93
MoscoStateChangeEvent()
sl@0
    94
*/
sl@0
    95
class MMdaObjectStateChangeObserver
sl@0
    96
	{
sl@0
    97
public:
sl@0
    98
	/**
sl@0
    99
	This method is used to receive the updated state of an audio data sample object.  This method must be implemented 
sl@0
   100
	by the inheriting client class.
sl@0
   101
sl@0
   102
	@param aObject
sl@0
   103
		   The audio data sample object whose state has changed.
sl@0
   104
sl@0
   105
	@param aPreviousState
sl@0
   106
		   This is the previous state of the audio data sample object before it went into the current state.  
sl@0
   107
		   It is expected to be one of the enum values defined in CMdaAudioClipUtility::TState, which defines 
sl@0
   108
		   the possible states of an audio data sample.
sl@0
   109
sl@0
   110
	@param aCurrentState
sl@0
   111
		   This is the current state of the audio data sample object.  It is expected to be one of the enum values defined 
sl@0
   112
		   in CMdaAudioClipUtility::TState, which defines the possible states of an audio data sample.
sl@0
   113
			
sl@0
   114
	@param aErrorCode
sl@0
   115
		   A system wide error code, KErrNone for sucessful completion.  KErrInUse, KErrDied or KErrAccessDenied 
sl@0
   116
		   may be returned to indicate that the sound device is in use  by another higher priority client.
sl@0
   117
	 */
sl@0
   118
	virtual void MoscoStateChangeEvent(CBase* aObject, TInt aPreviousState, TInt aCurrentState, TInt aErrorCode)=0;
sl@0
   119
	};
sl@0
   120
sl@0
   121
#endif