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