upnpframework/upnpcommand/inc/upnpimagerenderingengineobserver.h
changeset 0 7f85d04be362
equal deleted inserted replaced
-1:000000000000 0:7f85d04be362
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  observer for CUpnpImageRenderingEngine
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef UPNP_IMAGERENDERINGENGINEOBSERVER_H
       
    20 #define UPNP_IMAGERENDERINGENGINEOBSERVER_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "upnpavrenderingsessionobserver.h" // base class
       
    25 #include "upnpitemresolverobserver.h" // base class
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class CUpnpAVDevice;
       
    29 class MUPnPAVController;
       
    30 class MUPnPAVRenderingSession;
       
    31 class MUPnPAVSessionBase;
       
    32 class MUPnPItemResolver;
       
    33 class CUPnPCommonUI;
       
    34 
       
    35 /**
       
    36 * Observer interface for image rendering engine.
       
    37 *
       
    38 * @since S60 3.2
       
    39 */
       
    40 class MUpnpImageRenderingEngineObserver
       
    41     {
       
    42     public:
       
    43 
       
    44         /**
       
    45          * Requests for media to be rendered.
       
    46          * this method is called soon after calling PlayL().
       
    47          * the client is expected to provide an item resolver prepared with
       
    48          * the media to be played back (but not resolved yet)
       
    49          * ownership is transferred in this transaction.
       
    50          * if client returns NULL playback will fail to KErrCancelled
       
    51          * 
       
    52          * @return the resolver representing media to be played
       
    53          */
       
    54         virtual MUPnPItemResolver* GetMedia() = 0;
       
    55 
       
    56         /**
       
    57          * Acknowledge for render request
       
    58          * @param aError any errors that occurred
       
    59          * @param aItem the actual item that is playing, trying to play, or
       
    60          *        NULL if such is not available for some error condition
       
    61 		 * @return response error code
       
    62 		 *         KErrNone if the engine should carry on working
       
    63 		 *         KErrDisconnected if engine should disconnect
       
    64          */
       
    65         virtual TInt RenderAck(
       
    66             TInt aError,
       
    67             const CUpnpItem* aItem ) = 0; 
       
    68 
       
    69         /**
       
    70          * Notifies that rendering engine will shut down due to
       
    71          * communication failure.
       
    72          * @param aError the error code (some kind of reason)
       
    73          */
       
    74         virtual void EngineShutdown(
       
    75             TInt aError ) = 0;
       
    76             
       
    77     };
       
    78 
       
    79 
       
    80 #endif // UPNP_IMAGERENDERINGENGINEOBSERVER_H
       
    81 
       
    82 // End of File