mmresourcemgmt/mmresctrl/inc/mmrcclient.h
author hgs
Wed, 13 Oct 2010 12:08:48 +0100
changeset 3 28bdc4aca325
parent 0 79dd3e2336a0
permissions -rw-r--r--
2010wk42_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     1
//mmrcclient.h
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     2
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     3
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     4
// All rights reserved.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     5
// This component and the accompanying materials are made available
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     6
// under the terms of "Eclipse Public License v1.0"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     7
// which accompanies this distribution, and is available
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     8
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     9
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    10
// Initial Contributors:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    11
// Nokia Corporation - initial contribution.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    12
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    13
// Contributors:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    14
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    15
// Description:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    16
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    17
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    18
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    19
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    20
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    21
 @file
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    22
 @internalTechnology
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    23
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    24
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    25
#ifndef RMMRCCLIENT_H
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    26
#define RMMRCCLIENT_H
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    27
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    28
// INCLUDES
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    29
#include <e32std.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    30
#include <e32base.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    31
#include <a3f/a3fbase.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    32
#include "maudiostreamadaptationobserver.h"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    33
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    34
class MAudioContext;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    35
class MLogicalChain;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    36
class MMultimediaResourceControlObserver;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    37
class CMMRCServer;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    38
class CMMRCServerSession;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    39
class CMMRCClientImplementation;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    40
class CAudioContext;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    41
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    42
// CLASS DECLARATION
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    43
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    44
// This class opens connection and provides functions to MMRC server.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    45
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    46
// @lib mmrcclient.lib
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    47
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    48
class RMMRCClient
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    49
	{
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    50
public:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    51
	IMPORT_C RMMRCClient();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    52
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    53
	IMPORT_C virtual ~RMMRCClient();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    54
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    55
    //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    56
     // Open connection to server.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    57
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    58
     // @param aConnection Interface to server, must not be connected.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    59
     // @param aCallback Callback interface.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    60
     // @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    61
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    62
	IMPORT_C TInt Open(MMultimediaResourceControlObserver& aCallback);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    63
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    64
    //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    65
     // Zero is invalid Context id and indicates error.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    66
     // @param aProcessId Process Id.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    67
     // @return TUint32 Context Id.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    68
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    69
	IMPORT_C TUint64 LogOn(TProcessId aProcessId);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    70
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    71
    //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    72
     // Asynchronous return to ReceiveResourceResponse.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    73
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    74
     // @param aMessage Message to be sent.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    75
     // @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    76
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    77
	IMPORT_C TInt SendResourceRequest(MLogicalChain* aCurrent, MLogicalChain* aDesired, CAudioContext* aContext);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    78
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    79
    //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    80
     // Synchronous.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    81
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    82
     // @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    83
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    84
	IMPORT_C TInt SendResourceConfirmation();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    85
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    86
    //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    87
     // Synchronous.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    88
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    89
     // @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    90
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    91
	IMPORT_C TInt SendResourceUpdateResult();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    92
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    93
    //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    94
     // Synchronous.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    95
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    96
     // @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    97
     //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    98
	IMPORT_C TInt SendResourceErrorNotification();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    99
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   100
	//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   101
     // Close connection to server.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   102
	 //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   103
	IMPORT_C void Close();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   104
	//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   105
     // Register a client for notification.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   106
	 //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   107
	IMPORT_C TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   108
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   109
	//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   110
     // Cancel the register of a client for notification.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   111
	 //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   112
	IMPORT_C TInt CancelRegisterAsClient(TUid aEventType);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   113
	//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   114
     // 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   115
	 //
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   116
	IMPORT_C TInt WillResumePlay();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   117
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   118
	IMPORT_C void ResetMessages();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   119
	
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   120
private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   121
	CMMRCClientImplementation* iImplementation;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   122
	};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   123
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
   124
#endif  // RMMRCCLIENT_H