epoc32/include/mmf/common/mmfdurationinfocustomcommands.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
williamr@2
    17
#define __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
williamr@2
    18
williamr@2
    19
#ifdef SYMBIAN_CAF_V2
williamr@2
    20
williamr@2
    21
#include <e32base.h>
williamr@2
    22
#include <mmf/common/mmcaf.h>
williamr@2
    23
#include <mmf/common/mmfstandardcustomcommands.h>
williamr@2
    24
williamr@2
    25
williamr@2
    26
/**
williamr@2
    27
@publishedAll
williamr@2
    28
@deprecated 9.2- Replaced by KUidInterfaceMMFDurationInfoControl2
williamr@2
    29
*/
williamr@2
    30
williamr@2
    31
const TUid KUidInterfaceMMFDurationInfoControl = {0x102737C8};
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
@publishedPartner
williamr@2
    35
@released
williamr@2
    36
*/
williamr@2
    37
williamr@2
    38
const TUid KUidInterfaceMMFDurationInfoControl2 = {0x10273812};
williamr@2
    39
williamr@2
    40
/**
williamr@2
    41
@internalComponent
williamr@2
    42
*/
williamr@2
    43
enum TMMFDurationInfoMessages
williamr@2
    44
	{
williamr@2
    45
	EMMFGetDurationInfo
williamr@2
    46
	};
williamr@2
    47
	
williamr@2
    48
	
williamr@2
    49
/**
williamr@2
    50
@publishedPartner
williamr@2
    51
@released
williamr@2
    52
williamr@2
    53
The duration state of the controller.
williamr@2
    54
*/
williamr@2
    55
enum TMMFDurationInfo
williamr@2
    56
	{
williamr@2
    57
	EMMFDurationInfoValid, 		// Duration is known
williamr@2
    58
	EMMFDurationInfoUnknown,	// Invalid response from controller
williamr@2
    59
	EMMFDurationInfoInfinite,	// Clip is of infinite length
williamr@2
    60
	};
williamr@2
    61
williamr@2
    62
/**
williamr@2
    63
@publishedAll
williamr@2
    64
@deprecated 9.2 - Replaced by MMMFDurationInfoCustomCommandImplementor2
williamr@2
    65
williamr@2
    66
Mixin class to be derived from by controller plugins wishing to support the Duration information 
williamr@2
    67
custom commands
williamr@2
    68
*/
williamr@2
    69
class MMMFDurationInfoCustomCommandImplementor
williamr@2
    70
	{
williamr@2
    71
public:
williamr@2
    72
williamr@2
    73
	/**
williamr@2
    74
	Is the duration of the clip known? i.e. is the stream infinite?
williamr@2
    75
	
williamr@2
    76
	@param aDurationInfo
williamr@2
    77
		   Controller duration information
williamr@2
    78
		   
williamr@2
    79
	@return TMMFDurationInfo Duration state.
williamr@2
    80
	*/
williamr@2
    81
	virtual TMMFDurationInfo GetDurationInfo(TMMFDurationInfo& aDurationInfo)=0;
williamr@2
    82
	};
williamr@2
    83
williamr@2
    84
/**
williamr@2
    85
@publishedAll
williamr@2
    86
@deprecated 9.2 - Replaced by CMMFDurationInfoCustomCommandParser2
williamr@2
    87
*/
williamr@2
    88
class CMMFDurationInfoCustomCommandParser : public CMMFCustomCommandParserBase
williamr@2
    89
	{
williamr@2
    90
public:
williamr@2
    91
williamr@2
    92
	/**
williamr@2
    93
	Creates a new custom command parser capable of processing duration information controller commands.
williamr@2
    94
williamr@2
    95
	@param  aImplementor
williamr@2
    96
	        A reference to the controller plugin that owns this new object.
williamr@2
    97
williamr@2
    98
	@return A pointer to the object created.
williamr@2
    99
williamr@2
   100
	@since  9.1
williamr@2
   101
	*/
williamr@2
   102
	IMPORT_C static CMMFDurationInfoCustomCommandParser* NewL(MMMFDurationInfoCustomCommandImplementor& aImplementor);
williamr@2
   103
williamr@2
   104
	/**
williamr@2
   105
	Destructor.
williamr@2
   106
williamr@2
   107
	@since  9.1
williamr@2
   108
	*/
williamr@2
   109
	IMPORT_C ~CMMFDurationInfoCustomCommandParser();
williamr@2
   110
williamr@2
   111
	/**
williamr@2
   112
	Handles a request from the client. Called by the controller framework.
williamr@2
   113
williamr@2
   114
	@param  aMessage
williamr@2
   115
	        The message to be handled.
williamr@2
   116
williamr@2
   117
	@since  9.1
williamr@2
   118
	*/
williamr@2
   119
	void HandleRequest(TMMFMessage& aMessage);
williamr@2
   120
williamr@2
   121
private:
williamr@2
   122
	/**
williamr@2
   123
	Constructor.
williamr@2
   124
williamr@2
   125
	@param  aImplementor
williamr@2
   126
	        A reference to the controller plugin that owns this new object.
williamr@2
   127
	@since  9.1
williamr@2
   128
	*/
williamr@2
   129
	CMMFDurationInfoCustomCommandParser(MMMFDurationInfoCustomCommandImplementor& aImplementor);
williamr@2
   130
	
williamr@2
   131
	/**
williamr@2
   132
	Request duration information from the implementor
williamr@2
   133
williamr@2
   134
	@param  aMessage
williamr@2
   135
	        Message for writing results to the client.
williamr@2
   136
	*/
williamr@2
   137
	TInt GetDurationInfo(TMMFMessage& aMessage);
williamr@2
   138
williamr@2
   139
private:
williamr@2
   140
williamr@2
   141
	MMMFDurationInfoCustomCommandImplementor& iImplementor;
williamr@2
   142
	
williamr@2
   143
	};
williamr@2
   144
	
williamr@2
   145
/**
williamr@2
   146
@publishedPartner
williamr@2
   147
@released
williamr@2
   148
williamr@2
   149
Mixin class to be derived from by controller plugins wishing to support the Duration information 
williamr@2
   150
custom commands
williamr@2
   151
*/
williamr@2
   152
class MMMFDurationInfoCustomCommandImplementor2
williamr@2
   153
	{
williamr@2
   154
public:
williamr@2
   155
williamr@2
   156
	/**
williamr@2
   157
	Is the duration of the clip known? i.e. is the stream infinite?
williamr@2
   158
	
williamr@2
   159
	@param aDurationInfo
williamr@2
   160
		   Controller duration information
williamr@2
   161
		   
williamr@2
   162
	@return KErrNone or System wide error code
williamr@2
   163
	*/
williamr@2
   164
	virtual TInt GetDurationInfo(TMMFDurationInfo& aDurationInfo)=0;
williamr@2
   165
	};
williamr@2
   166
	
williamr@2
   167
/**
williamr@2
   168
@publishedPartner
williamr@2
   169
@released
williamr@2
   170
williamr@2
   171
Custom command parser capable of processing duration information controller commands
williamr@2
   172
*/
williamr@2
   173
class CMMFDurationInfoCustomCommandParser2 : public CMMFCustomCommandParserBase
williamr@2
   174
	{
williamr@2
   175
public:
williamr@2
   176
williamr@2
   177
	/**
williamr@2
   178
	Creates a new custom command parser capable of processing duration information controller commands.
williamr@2
   179
williamr@2
   180
	@param  aImplementor
williamr@2
   181
	        A reference to the controller plugin that owns this new object.
williamr@2
   182
williamr@2
   183
	@return A pointer to the object created.
williamr@2
   184
williamr@2
   185
	@since  9.2
williamr@2
   186
	*/
williamr@2
   187
	IMPORT_C static CMMFDurationInfoCustomCommandParser2* NewL(MMMFDurationInfoCustomCommandImplementor2& aImplementor);
williamr@2
   188
williamr@2
   189
	/**
williamr@2
   190
	Destructor.
williamr@2
   191
williamr@2
   192
	@since  9.2
williamr@2
   193
	*/
williamr@2
   194
	IMPORT_C ~CMMFDurationInfoCustomCommandParser2();
williamr@2
   195
williamr@2
   196
	/**
williamr@2
   197
	Handles a request from the client. Called by the controller framework.
williamr@2
   198
williamr@2
   199
	@param  aMessage
williamr@2
   200
	        The message to be handled.
williamr@2
   201
williamr@2
   202
	@since  9.2
williamr@2
   203
	*/
williamr@2
   204
	void HandleRequest(TMMFMessage& aMessage);
williamr@2
   205
williamr@2
   206
private:
williamr@2
   207
	/**
williamr@2
   208
	Constructor.
williamr@2
   209
williamr@2
   210
	@param  aImplementor
williamr@2
   211
	        A reference to the controller plugin that owns this new object.
williamr@2
   212
	@since  9.2
williamr@2
   213
	*/
williamr@2
   214
	CMMFDurationInfoCustomCommandParser2(MMMFDurationInfoCustomCommandImplementor2& aImplementor);
williamr@2
   215
	
williamr@2
   216
	/**
williamr@2
   217
	Request duration information from the implementor
williamr@2
   218
williamr@2
   219
	@param  aMessage
williamr@2
   220
	        Message for writing results to the client.
williamr@2
   221
	*/
williamr@2
   222
	TInt GetDurationInfo(TMMFMessage& aMessage);
williamr@2
   223
williamr@2
   224
private:
williamr@2
   225
	MMMFDurationInfoCustomCommandImplementor2& iImplementor;
williamr@2
   226
	};
williamr@2
   227
williamr@2
   228
#endif // SYMBIAN_CAF_V2
williamr@2
   229
williamr@2
   230
#endif // __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__