epoc32/include/mmf/common/mmfdurationinfocustomcommands.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
--- a/epoc32/include/mmf/common/mmfdurationinfocustomcommands.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/mmf/common/mmfdurationinfocustomcommands.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,230 @@
-mmfdurationinfocustomcommands.h
+// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// 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
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+#ifndef __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
+#define __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__
+
+#ifdef SYMBIAN_CAF_V2
+
+#include <e32base.h>
+#include <mmf/common/mmcaf.h>
+#include <mmf/common/mmfstandardcustomcommands.h>
+
+
+/**
+@publishedAll
+@deprecated 9.2- Replaced by KUidInterfaceMMFDurationInfoControl2
+*/
+
+const TUid KUidInterfaceMMFDurationInfoControl = {0x102737C8};
+
+/**
+@publishedPartner
+@released
+*/
+
+const TUid KUidInterfaceMMFDurationInfoControl2 = {0x10273812};
+
+/**
+@internalComponent
+*/
+enum TMMFDurationInfoMessages
+	{
+	EMMFGetDurationInfo
+	};
+	
+	
+/**
+@publishedPartner
+@released
+
+The duration state of the controller.
+*/
+enum TMMFDurationInfo
+	{
+	EMMFDurationInfoValid, 		// Duration is known
+	EMMFDurationInfoUnknown,	// Invalid response from controller
+	EMMFDurationInfoInfinite,	// Clip is of infinite length
+	};
+
+/**
+@publishedAll
+@deprecated 9.2 - Replaced by MMMFDurationInfoCustomCommandImplementor2
+
+Mixin class to be derived from by controller plugins wishing to support the Duration information 
+custom commands
+*/
+class MMMFDurationInfoCustomCommandImplementor
+	{
+public:
+
+	/**
+	Is the duration of the clip known? i.e. is the stream infinite?
+	
+	@param aDurationInfo
+		   Controller duration information
+		   
+	@return TMMFDurationInfo Duration state.
+	*/
+	virtual TMMFDurationInfo GetDurationInfo(TMMFDurationInfo& aDurationInfo)=0;
+	};
+
+/**
+@publishedAll
+@deprecated 9.2 - Replaced by CMMFDurationInfoCustomCommandParser2
+*/
+class CMMFDurationInfoCustomCommandParser : public CMMFCustomCommandParserBase
+	{
+public:
+
+	/**
+	Creates a new custom command parser capable of processing duration information controller commands.
+
+	@param  aImplementor
+	        A reference to the controller plugin that owns this new object.
+
+	@return A pointer to the object created.
+
+	@since  9.1
+	*/
+	IMPORT_C static CMMFDurationInfoCustomCommandParser* NewL(MMMFDurationInfoCustomCommandImplementor& aImplementor);
+
+	/**
+	Destructor.
+
+	@since  9.1
+	*/
+	IMPORT_C ~CMMFDurationInfoCustomCommandParser();
+
+	/**
+	Handles a request from the client. Called by the controller framework.
+
+	@param  aMessage
+	        The message to be handled.
+
+	@since  9.1
+	*/
+	void HandleRequest(TMMFMessage& aMessage);
+
+private:
+	/**
+	Constructor.
+
+	@param  aImplementor
+	        A reference to the controller plugin that owns this new object.
+	@since  9.1
+	*/
+	CMMFDurationInfoCustomCommandParser(MMMFDurationInfoCustomCommandImplementor& aImplementor);
+	
+	/**
+	Request duration information from the implementor
+
+	@param  aMessage
+	        Message for writing results to the client.
+	*/
+	TInt GetDurationInfo(TMMFMessage& aMessage);
+
+private:
+
+	MMMFDurationInfoCustomCommandImplementor& iImplementor;
+	
+	};
+	
+/**
+@publishedPartner
+@released
+
+Mixin class to be derived from by controller plugins wishing to support the Duration information 
+custom commands
+*/
+class MMMFDurationInfoCustomCommandImplementor2
+	{
+public:
+
+	/**
+	Is the duration of the clip known? i.e. is the stream infinite?
+	
+	@param aDurationInfo
+		   Controller duration information
+		   
+	@return KErrNone or System wide error code
+	*/
+	virtual TInt GetDurationInfo(TMMFDurationInfo& aDurationInfo)=0;
+	};
+	
+/**
+@publishedPartner
+@released
+
+Custom command parser capable of processing duration information controller commands
+*/
+class CMMFDurationInfoCustomCommandParser2 : public CMMFCustomCommandParserBase
+	{
+public:
+
+	/**
+	Creates a new custom command parser capable of processing duration information controller commands.
+
+	@param  aImplementor
+	        A reference to the controller plugin that owns this new object.
+
+	@return A pointer to the object created.
+
+	@since  9.2
+	*/
+	IMPORT_C static CMMFDurationInfoCustomCommandParser2* NewL(MMMFDurationInfoCustomCommandImplementor2& aImplementor);
+
+	/**
+	Destructor.
+
+	@since  9.2
+	*/
+	IMPORT_C ~CMMFDurationInfoCustomCommandParser2();
+
+	/**
+	Handles a request from the client. Called by the controller framework.
+
+	@param  aMessage
+	        The message to be handled.
+
+	@since  9.2
+	*/
+	void HandleRequest(TMMFMessage& aMessage);
+
+private:
+	/**
+	Constructor.
+
+	@param  aImplementor
+	        A reference to the controller plugin that owns this new object.
+	@since  9.2
+	*/
+	CMMFDurationInfoCustomCommandParser2(MMMFDurationInfoCustomCommandImplementor2& aImplementor);
+	
+	/**
+	Request duration information from the implementor
+
+	@param  aMessage
+	        Message for writing results to the client.
+	*/
+	TInt GetDurationInfo(TMMFMessage& aMessage);
+
+private:
+	MMMFDurationInfoCustomCommandImplementor2& iImplementor;
+	};
+
+#endif // SYMBIAN_CAF_V2
+
+#endif // __MMF_DURATION_INFO_CUSTOM_COMMANDS_H__