epoc32/include/remconabsvolcontroller.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
--- a/epoc32/include/remconabsvolcontroller.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/remconabsvolcontroller.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,99 @@
-remconabsvolcontroller.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:
+//
+
+
+
+/**
+ @file
+ @publishedAll
+ @released
+*/
+
+#ifndef REMCONABSVOLCONTROLLER_H
+#define REMCONABSVOLCONTROLLER_H
+
+#include <e32base.h>
+#include <remcon/remconinterfacebase.h>
+#include <remcon/remconinterfaceif.h>
+
+class MRemConAbsVolControllerObserver;
+class CRemConInterfaceSelector;
+
+/**
+Client-instantiable type supporting sending AbsVol API responses.
+*/
+NONSHARABLE_CLASS(CRemConAbsVolController) : public CRemConInterfaceBase, 
+								             public MRemConInterfaceIf
+	{
+public:
+	/**
+	Factory function.
+	@param aInterfaceSelector The interface selector. The client must have 
+	created one of these first.
+	@param aObserver The observer of this interface.
+	@return A new CRemConAbsVolController, owned by the interface selector.
+	*/
+	IMPORT_C static CRemConAbsVolController* NewL(CRemConInterfaceSelector& aInterfaceSelector, 
+		MRemConAbsVolControllerObserver& aObserver);
+	
+	/** Destructor. */
+	IMPORT_C ~CRemConAbsVolController();
+
+public:
+	/**
+	Sends a 'get absolute volume' command. The absolute volume will be 
+	returned in response(s) via the observer interface.
+	Only one command per controller session can be outstanding at any one time.
+	@param aStatus Used by RemCon to indicate completion of the send request. 
+	@param aNumRemotes The number of remotes to which the command was sent.
+	*/
+	IMPORT_C void GetAbsoluteVolume(TRequestStatus& aStatus, TUint& aNumRemotes);
+
+	/**
+	Sends a 'set absolute volume' command. The volume is set to aAbsVol, on a 
+	range of zero to aMaxVol. Any responses will be returned via the observer 
+	interface.
+	Only one command per controller session can be outstanding at any one time.
+	@param aStatus Used by RemCon to indicate completion of the send request.
+	@param aAbsVol The relative volume.
+	@param aMaxVol The maximum against which aAbsVol is relative.
+	@param aNumRemotes The number of remotes to which the command was sent.
+	*/
+	IMPORT_C void SetAbsoluteVolume(TRequestStatus& aStatus, TUint aAbsVol, TUint aMaxVol, TUint& aNumRemotes);
+
+private:
+	/** 
+	Constructor.
+	@param aInterfaceSelector The interface selector.
+	@param aObserver The observer of this interface.
+	*/
+	CRemConAbsVolController(CRemConInterfaceSelector& aInterfaceSelector, 
+		MRemConAbsVolControllerObserver& aObserver);
+
+private: // from CRemConInterfaceBase
+	TAny* GetInterfaceIf(TUid aUid);
+
+private: // from MRemConInterfaceIf
+	void MrcibNewMessage(TUint aOperationId, const TDesC8& aData);
+
+private: // unowned
+	MRemConAbsVolControllerObserver& iObserver;
+
+private: // owned
+	static const TUint KMaxOperationDataSize = 0x20;
+	TBuf8<KMaxOperationDataSize> iOutData;
+	};
+
+#endif // REMCONABSVOLCONTROLLER_H