mmlibs/mmfw/inc/mmf/ControllerFramework/mmfcontrollerextendeddata.h
author hgs
Tue, 02 Nov 2010 12:28:51 +0000
changeset 6 fe9d1bf55678
parent 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk46_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
// All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
// Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
// Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
// Description:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
#ifndef __MMFCONTROLLEREXTENDEDDATA_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
#define __MMFCONTROLLEREXTENDEDDATA_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
#include <mmf/server/mmfdatasource.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
#include <mmf/server/mmfdatasink.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#include <mmf/common/mmfcontrollerframework.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
#include <mmf/common/mmfcontrollerpluginresolver.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
#include <mmfplugininterfaceuids.hrh>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
#include <caf/caf.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
@internalComponent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
const TUid KUidInterfaceMMFDataSinkHolder = {0x101F76D4};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
@internalComponent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
const TUid KUidInterfaceMMFDataSourceHolder = {0x101F76D5};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
@internalComponent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
const TUid KUidMMFControllerExtendedDataHolder = {0x102834AC};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
@internalComponent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
Create a const TUid with the same values as the controller
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
ECOM plugin interface UID
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
const TUid KUidInterfaceMMFController = {KMmfUidPluginInterfaceController};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
@internalComponent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
IPC messages for interface KUidInterfaceMMFController in the controller framework.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
enum TMMFControllerMessages
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
	EMMFControllerAddDataSource,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
	EMMFControllerAddDataSink,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
	EMMFControllerRemoveDataSource,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
	EMMFControllerRemoveDataSink,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
	EMMFControllerReset,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
	EMMFControllerPrime,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
	EMMFControllerPlay,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
	EMMFControllerPause,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
	EMMFControllerStop,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
	EMMFControllerGetPosition,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
	EMMFControllerSetPosition,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
	EMMFControllerGetDuration,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
	EMMFControllerGetNumberOfMetaDataEntries,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
	EMMFControllerGetSizeOfMetaDataEntry,//use internally
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
	EMMFControllerGetMetaDataEntry,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
	EMMFControllerSetPrioritySettings,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
	EMMFControllerCancelAddDataSource,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
	EMMFControllerCancelAddDataSink,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
	EMMFControllerAddFileHandleDataSource,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
	EMMFControllerAddFileHandleDataSink,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
	EMMFControllerSourceSinkInitDataPreload,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
	EMMFControllerAddFileHandleDataSourceWithInitData,
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
	EMMFControllerAddFileHandleDataSinkWithInitData
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
@internalComponent
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
The controller proxy session.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
Only one session can be connected to a controller proxy server.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
NONSHARABLE_CLASS(CMMFControllerExtendedData) : public CMMFObject
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
	CMMFControllerExtendedData();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
	~CMMFControllerExtendedData();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
	// Set/Get the source/sink initialization data used by CMMFController
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    97
	// Ownership of aSourceSinkInitData is transferred (NULL pointer is allow)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    98
	// If source/sink initialization data is already set, previous one will be destroyed
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    99
	void SetSourceSinkInitData(HBufC8* aSourceSinkInitData);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   100
	HBufC8* SourceSinkInitData() const;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
	void ResetSourceSinkInitData();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
	// Set/Get the client thread ID used by CMMFController
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
	void SetClientThreadId(TThreadId aClientThreadId);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
	TThreadId ClientThreadId() const;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
	// Set/Get the Secure DRM mode of CMMFController
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
	void SetSecureDrmMode(TBool aSecureDrmMode);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
	TBool SecureDrmMode() const;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
		
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
	//from CMMFObject
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
	void HandleRequest(TMMFMessage& aMessage);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
	Extended data uses by CMMFController: Source/Sink initialization data
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
	It serves as a temporary storage for Source/Sink initialization
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
	Client should request the server to use and cleanup this variable ASAP
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   118
	once it is being loaded
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   119
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   120
	HBufC8*	iSourceSinkInitData;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   121
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   122
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   123
	Extended data uses by CMMFController: The client thread Id
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   124
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   125
	TThreadId iClientThreadId;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   126
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   127
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   128
	Extended data uses by CMMFController: Controller Scecure DRM Mode
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   129
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   130
	TBool iSecureDrmMode;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   131
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   132
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   133
#endif //__MMFCONTROLLEREXTENDEDDATA_H__