epoc32/include/remconmediainformationtarget.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2007-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
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
#ifndef REMCONMEDIAINFORMATIONTARGET_H
williamr@2
    25
#define REMCONMEDIAINFORMATIONTARGET_H
williamr@2
    26
williamr@2
    27
#include <e32base.h>
williamr@2
    28
#include <remcon/remconinterfacebase.h>
williamr@2
    29
#include <remcon/remconinterfaceif.h>
williamr@2
    30
#include <remcon/mediainformation.h>
williamr@2
    31
#include <remconmediainformationtargetobserver.h>
williamr@2
    32
williamr@2
    33
class CRemConInterfaceSelector;
williamr@2
    34
williamr@2
    35
NONSHARABLE_CLASS(CRemConMediaInformationQueuedMessage): public CBase
williamr@2
    36
	{
williamr@2
    37
public:
williamr@2
    38
	static CRemConMediaInformationQueuedMessage* NewL(const TDesC8& aData);
williamr@2
    39
	~CRemConMediaInformationQueuedMessage();
williamr@2
    40
	
williamr@2
    41
	const TDesC8& Data();
williamr@2
    42
private:
williamr@2
    43
	CRemConMediaInformationQueuedMessage();
williamr@2
    44
	void ConstructL(const TDesC8& aData);
williamr@2
    45
public:
williamr@2
    46
	TSglQueLink iLink;
williamr@2
    47
private:
williamr@2
    48
	RBuf8 iData;
williamr@2
    49
	};
williamr@2
    50
williamr@2
    51
/**
williamr@2
    52
Client-instantiable type supporting sending media information.
williamr@2
    53
*/
williamr@2
    54
NONSHARABLE_CLASS(CRemConMediaInformationTarget) : public CRemConInterfaceBase, 
williamr@2
    55
								          		public MRemConInterfaceIf
williamr@2
    56
	{
williamr@2
    57
public:
williamr@2
    58
williamr@2
    59
	/**
williamr@2
    60
	Factory function.
williamr@2
    61
	@param aInterfaceSelector The interface selector. The client must have 
williamr@2
    62
	created one of these first.
williamr@2
    63
	@param aObserver The observer of this interface.
williamr@2
    64
	@return A new CRemConMediaInformationTarget, owned by the interface selector.
williamr@2
    65
	*/
williamr@2
    66
	IMPORT_C static CRemConMediaInformationTarget* NewL(CRemConInterfaceSelector& aInterfaceSelector, 
williamr@2
    67
		MRemConMediaInformationTargetObserver& aObserver);
williamr@2
    68
	
williamr@2
    69
	/** Destructor */
williamr@2
    70
	IMPORT_C ~CRemConMediaInformationTarget();
williamr@2
    71
williamr@2
    72
public:
williamr@2
    73
	/** Called by the client in response to a MrcmitoGetCurrentlyPlayingMetadata() call.
williamr@2
    74
	Each call provides one of the attribute values requested.
williamr@2
    75
	This is repeatedly called until all attributes requested have been supplied and then followed by Completed().
williamr@2
    76
	@param aAttribute The ID of the attribute supplied.
williamr@2
    77
	@param aValue A reference to a descriptor containing the attribute data.  
williamr@2
    78
	This must be valid until Completed() has been called. 
williamr@2
    79
	@see MRemConMediaInformationTargetObserver::MrcmitoGetCurrentlyPlayingMetadata()
williamr@2
    80
	@see CRemConMediaInformationTarget::Completed()
williamr@2
    81
	*/
williamr@2
    82
	IMPORT_C TInt AttributeValue( TMediaAttributeId aAttributeId, TDesC8& aAttributeData);
williamr@2
    83
	
williamr@2
    84
	/** Signal that all attributes requested by MrcmitoGetCurrentlyPlayingMetadata() have been supplied
williamr@2
    85
	using the AttributeValue() method.
williamr@2
    86
	@see MRemConMediaInformationTargetObserver::MrcmitoGetCurrentlyPlayingMetadata()
williamr@2
    87
	@see CRemConMediaInformationTarget::AttributeValue()
williamr@2
    88
	*/
williamr@2
    89
	IMPORT_C void Completed();
williamr@2
    90
	
williamr@2
    91
private:
williamr@2
    92
	/** 
williamr@2
    93
	Constructor.
williamr@2
    94
	@param aInterfaceSelector The interface selector.
williamr@2
    95
	@param aObserver The observer of this interface.
williamr@2
    96
	*/
williamr@2
    97
	CRemConMediaInformationTarget(CRemConInterfaceSelector& aInterfaceSelector, 
williamr@2
    98
		MRemConMediaInformationTargetObserver& aObserver);
williamr@2
    99
williamr@2
   100
	void ConstructL();
williamr@2
   101
williamr@2
   102
private: // from CRemConInterfaceBase
williamr@2
   103
	TAny* GetInterfaceIf(TUid aUid);
williamr@2
   104
williamr@2
   105
private: // from MRemConInterfaceIf
williamr@2
   106
	void MrcibNewMessage(TUint aOperationId, const TDesC8& aData);
williamr@2
   107
williamr@2
   108
private: // utility
williamr@2
   109
	void SendError(TInt aError);
williamr@2
   110
	void ProcessMessage(const TDesC8& aData);
williamr@2
   111
	
williamr@2
   112
	static int NextMessageCb(TAny* aThis);
williamr@2
   113
	void DoNextMessage();
williamr@2
   114
private: // unowned
williamr@2
   115
	MRemConMediaInformationTargetObserver& iObserver;
williamr@2
   116
williamr@2
   117
private: // owned
williamr@2
   118
	RRemConGetElementAttributesResponse iResponse;
williamr@2
   119
williamr@2
   120
	RArray<TMediaAttributeId>  	iMediaAttributeIDs;
williamr@2
   121
	TMediaAttributeIter 		iAttributeIterator;
williamr@2
   122
	TBool						iInProgress;
williamr@2
   123
	TSglQue<CRemConMediaInformationQueuedMessage> iMsgQueue;
williamr@2
   124
	
williamr@2
   125
	CAsyncCallBack* iNextMessageCallBack;
williamr@2
   126
	};
williamr@2
   127
williamr@2
   128
#endif // REMCONMEDIAINFORMATIONTARGET_H