epoc32/include/mw/remcondatabaseunawarenowplayingtargetobserver.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.
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file
    20  @publishedAll
    21  @released
    22 */
    23 
    24 #ifndef REMCONDATABASEUNAWARENOWPLAYINGTARGETOBSERVER_H
    25 #define REMCONDATABASEUNAWARENOWPLAYINGTARGETOBSERVER_H
    26 
    27 #include <remconmediabrowsetypes.h>
    28 
    29 /**
    30 It is intended for the client which is database aware.
    31 Clients must implement this interface in order to instantiate objects of type 
    32 CRemConDatabaseUnawareNowPlayingTarget. This interface passes incoming 
    33 commands from RemCon to the client. 
    34 
    35 @see CRemConDatabaseUnawareNowPlayingTarget
    36 */
    37 NONSHARABLE_CLASS(MRemConDatabaseUnawareNowPlayingTargetObserver) 
    38 	{
    39 public:
    40 	/**
    41 	Requests to play an item.
    42 	
    43 	@param aItem The item requested to play. 
    44 	     - If it does not refer to any valid item, the client must call 
    45 	       CRemConNowPlayingTargetBase::PlayItemResponse() with the error 
    46 	       KErrInvalidUid;	
    47 	     - If it refers to a directory which can not be handled by this media 
    48 	       player, the client must call 
    49 	       CRemConNowPlayingTargetBase::PlayItemResponse() 
    50 	       with the error KErrNowPlayingUidIsADirectory;
    51 	     - If it is in use and can not be played, the client must call 
    52 	       CRemConNowPlayingTargetBase::PlayItemResponse() 
    53 	       with the error KErrNowPlayingMediaInUse;
    54 	
    55 	@param aScope The scope in which the item was requested to play. 
    56 	
    57     @see CRemConNowPlayingTargetBase::PlayItemResponse().
    58 	*/
    59 	virtual void MrcdunptoPlayItem(const TRemConItemUid& aItem, 
    60 			TRemConFolderScope aScope) = 0;
    61 
    62 	/**
    63 	Requests to add an item to now playing list.
    64 	
    65 	@param aItem The item requested to play.
    66 	     - If it does not refer to any valid item, the client must call 
    67 	       CRemConNowPlayingTargetBase::AddToNowPlayingResponse() 
    68 	       with the error KErrInvalidUid;
    69 	     - If it refers to a directory which can not be handled by this media 
    70 	       player, the client must call 
    71 	       CRemConNowPlayingTargetBase::AddToNowPlayingResponse() 
    72 	       with the error KErrNowPlayingUidIsADirectory;
    73 	     - If it is in use and can not be added to now playing list, the 
    74 	       client must call 
    75 	       CRemConNowPlayingTargetBase::AddToNowPlayingResponse() 
    76 	       with the error KErrNowPlayingMediaInUse;
    77 	
    78 	@param aScope The scope in which the item was requested to play. 
    79 	
    80     @see CRemConNowPlayingTargetBase::AddToNowPlayingResponse().
    81 	*/
    82 	virtual void MrcdunptoAddToNowPlaying(const TRemConItemUid& aItem, 
    83 			TRemConFolderScope aScope) = 0;
    84 	};
    85 
    86 #endif //REMCONDATABASEUNAWARENOWPLAYINGTARGETOBSERVER_H