mmlibs/mmfw/inc/mmf/ControllerFramework/mmfdurationinfocustomcommands.h
author hgs
Thu, 07 Oct 2010 22:34:12 +0100
changeset 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2004-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
#ifndef __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
#define __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
#ifdef SYMBIAN_CAF_V2
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
#include <e32base.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#include <mmf/common/mmcaf.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
#include <mmf/common/mmfstandardcustomcommands.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
@deprecated 9.2- Replaced by KUidInterfaceMMFDurationInfoControl2
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
const TUid KUidInterfaceMMFDurationInfoControl = {0x102737C8};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
@released
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
The duration state of the controller.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
enum TMMFDurationInfo
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
	EMMFDurationInfoValid, 		// Duration is known
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
	EMMFDurationInfoUnknown,	// Invalid response from controller
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
	EMMFDurationInfoInfinite,	// Clip is of infinite length
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
#include <mmf/common/mmfdurationinfocustomcommandsimpl.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
#include <mmf/common/mmfdurationinfocustomcommandsenums.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
#endif
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
@deprecated 9.2 - Replaced by MMMFDurationInfoCustomCommandImplementor2
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
Mixin class to be derived from by controller plugins wishing to support the Duration information 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
custom commands
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
class MMMFDurationInfoCustomCommandImplementor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
	Is the duration of the clip known? i.e. is the stream infinite?
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
	@param aDurationInfo
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
		   Controller duration information
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
		   
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
	@return TMMFDurationInfo Duration state.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
	virtual TMMFDurationInfo GetDurationInfo(TMMFDurationInfo& aDurationInfo)=0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
@publishedAll
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
@deprecated 9.2 - Replaced by CMMFDurationInfoCustomCommandParser2
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
class CMMFDurationInfoCustomCommandParser : public CMMFCustomCommandParserBase
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
	Creates a new custom command parser capable of processing duration information controller commands.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
	@param  aImplementor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
	        A reference to the controller plugin that owns this new object.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
	@return A pointer to the object created.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
	@since  9.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
	IMPORT_C static CMMFDurationInfoCustomCommandParser* NewL(MMMFDurationInfoCustomCommandImplementor& aImplementor);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
	Destructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
	@since  9.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    97
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    98
	IMPORT_C ~CMMFDurationInfoCustomCommandParser();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    99
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   100
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
	Handles a request from the client. Called by the controller framework.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
	@param  aMessage
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
	        The message to be handled.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
	@since  9.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
	void HandleRequest(TMMFMessage& aMessage);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
	Constructor.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
	@param  aImplementor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
	        A reference to the controller plugin that owns this new object.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
	@since  9.1
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   118
	CMMFDurationInfoCustomCommandParser(MMMFDurationInfoCustomCommandImplementor& aImplementor);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   119
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   120
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   121
	Request duration information from the implementor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   122
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   123
	@param  aMessage
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   124
	        Message for writing results to the client.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   125
	*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   126
	TInt GetDurationInfo(TMMFMessage& aMessage);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   127
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   128
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   129
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   130
	MMMFDurationInfoCustomCommandImplementor& iImplementor;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   131
	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   132
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   133
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   134
#endif // SYMBIAN_CAF_V2
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   135
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   136
#endif // __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   137