remotecontrol/avrcp/nowplayingapi/public/remcondatabaseawarenowplayingtargetobserver.h
author hgs
Wed, 13 Oct 2010 16:20:29 +0300
changeset 51 20ac952a623c
permissions -rw-r--r--
201040_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
20ac952a623c 201040_02
hgs
parents:
diff changeset
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
20ac952a623c 201040_02
hgs
parents:
diff changeset
     2
// All rights reserved.
20ac952a623c 201040_02
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
20ac952a623c 201040_02
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
20ac952a623c 201040_02
hgs
parents:
diff changeset
     7
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
     8
// Initial Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    10
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    11
// Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    12
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    13
// Description:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    14
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    15
20ac952a623c 201040_02
hgs
parents:
diff changeset
    16
20ac952a623c 201040_02
hgs
parents:
diff changeset
    17
20ac952a623c 201040_02
hgs
parents:
diff changeset
    18
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    19
 @file
20ac952a623c 201040_02
hgs
parents:
diff changeset
    20
 @publishedAll
20ac952a623c 201040_02
hgs
parents:
diff changeset
    21
 @released
20ac952a623c 201040_02
hgs
parents:
diff changeset
    22
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    23
20ac952a623c 201040_02
hgs
parents:
diff changeset
    24
#ifndef REMCONDATABASEAWARENOWPLAYINGTARGETOBSERVER_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    25
#define REMCONDATABASEAWARENOWPLAYINGTARGETOBSERVER_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    26
20ac952a623c 201040_02
hgs
parents:
diff changeset
    27
#include <remconmediabrowsetypes.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    28
20ac952a623c 201040_02
hgs
parents:
diff changeset
    29
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    30
It is intended for the client which is database aware.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    31
Clients must implement this interface in order to instantiate objects of type 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    32
CRemConDatabaseAwareNowPlayingTarget. This interface passes incoming commands 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    33
from RemCon to the client. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    34
20ac952a623c 201040_02
hgs
parents:
diff changeset
    35
@see CRemConDatabaseAwareNowPlayingTarget
20ac952a623c 201040_02
hgs
parents:
diff changeset
    36
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    37
NONSHARABLE_CLASS(MRemConDatabaseAwareNowPlayingTargetObserver) 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    38
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    39
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    40
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    41
	Requests to play an item.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    42
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    43
	@param aItem The item requested to play. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    44
	     - If it does not refer to any valid item, the client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    45
	       CRemConNowPlayingTargetBase::PlayItemResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    46
	       with the error KErrInvalidUid;	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    47
	     - If it refers to a directory which can not be handled by this media 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    48
	       player, the client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    49
	       CRemConNowPlayingTargetBase::PlayItemResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    50
	       with the error KErrNowPlayingUidIsADirectory;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    51
	     - If it is in use and can not be played, the client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    52
	       CRemConNowPlayingTargetBase::PlayItemResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    53
	       with the error KErrNowPlayingMediaInUse;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    54
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    55
	@param aScope The scope in which the item was requested to play. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    56
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    57
	@param aMediaLibraryStateCookie The cookie which the remote device 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    58
	       believes refers to the current state of the media library. If this
20ac952a623c 201040_02
hgs
parents:
diff changeset
    59
	       does not match the current state according to the client then the 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    60
	       client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    61
	       CRemConNowPlayingTargetBase::PlayItemResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    62
	       with the error KErrInvalidMediaLibraryStateCookie.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    63
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    64
    @see CRemConNowPlayingTargetBase::PlayItemResponse().
20ac952a623c 201040_02
hgs
parents:
diff changeset
    65
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    66
	virtual void MrcdanptoPlayItem(const TRemConItemUid& aItem, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    67
			TRemConFolderScope aScope, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    68
			TUint16 aMediaLibraryStateCookie) = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    69
20ac952a623c 201040_02
hgs
parents:
diff changeset
    70
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    71
	Requests to add an item to now playing list.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    72
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    73
	@param aItem The item requested to play.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    74
	     - If it does not refer to any valid item, the client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    75
	       CRemConNowPlayingTargetBase::AddToNowPlayingResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    76
	       with the error KErrInvalidUid;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    77
	     - If it refers to a directory which can not be handled by this media 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    78
	       player, the client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    79
	       CRemConNowPlayingTargetBase::AddToNowPlayingResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    80
	       with the error KErrNowPlayingUidIsADirectory;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    81
	     - If it is in use and can not be added to now playing list, the 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    82
	       client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    83
	       CRemConNowPlayingTargetBase::AddToNowPlayingResponse() 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    84
	       with the error KErrNowPlayingMediaInUse;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    85
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    86
	@param aScope The scope in which the item was requested to play. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    87
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    88
	@param aMediaLibraryStateCookie The cookie which the remote device 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    89
	       believes refers to the current state of the media library. If this 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    90
	       does not match the current state according to the client then the 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    91
	       client must call 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    92
	       CRemConNowPlayingTargetBase::PlayItemResponse()
20ac952a623c 201040_02
hgs
parents:
diff changeset
    93
	       with the error KErrInvalidMediaLibraryStateCookie.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    94
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    95
    @see CRemConNowPlayingTargetBase::AddToNowPlayingResponse().
20ac952a623c 201040_02
hgs
parents:
diff changeset
    96
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    97
	virtual void MrcdanptoAddToNowPlaying(const TRemConItemUid& aItem, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    98
			TRemConFolderScope aScope, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    99
			TUint16 aMediaLibraryStateCookie) = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
   100
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
   101
20ac952a623c 201040_02
hgs
parents:
diff changeset
   102
20ac952a623c 201040_02
hgs
parents:
diff changeset
   103
#endif //REMCONDATABASEAWARENOWPLAYINGTARGETOBSERVER_H