upnpavcontroller/upnpavcontrollerclient/inc/upnpavrenderingsession.h
changeset 0 7f85d04be362
child 38 5360b7ddc251
equal deleted inserted replaced
-1:000000000000 0:7f85d04be362
       
     1 /*
       
     2 * Copyright (c) 2006 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:      interface for session against a renderer
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 #ifndef C_UPNPAVRENDERINGSESSION_H
       
    24 #define C_UPNPAVRENDERINGSESSION_H
       
    25 
       
    26 #include <e32std.h>
       
    27 #include "upnpavsessionbase.h"
       
    28 
       
    29 class MUPnPAVRenderingSessionObserver;
       
    30 class CUpnpItem;
       
    31 
       
    32 /**
       
    33  *  AV Controller rendering session interface.
       
    34  *
       
    35  *  This class defines the rendering interface of AV Controller.
       
    36  *  Includes operations to set and to set next uri, play, stop and
       
    37  *  pause the playback, to set the volume and mute and to get the
       
    38  *  position information
       
    39  *
       
    40  *  @lib upnpavcontrollerclient.lib
       
    41  *  @since S60 v3.1
       
    42  */
       
    43  class MUPnPAVRenderingSession : public MUPnPAVSessionBase
       
    44     {
       
    45 
       
    46 public:
       
    47 
       
    48     /**
       
    49      * Sets the rendering session observer
       
    50      *
       
    51      * @since Series 60 3.1      
       
    52      * @param aObserver rendering session observer
       
    53      * @return none
       
    54      */
       
    55     virtual void SetObserver(
       
    56         MUPnPAVRenderingSessionObserver& aObserver ) = 0;
       
    57 
       
    58     /**
       
    59      * Removes the rendering session observer
       
    60      *
       
    61      * @since Series 60 3.1     
       
    62      * @param None
       
    63      * @return None
       
    64      */
       
    65     virtual void RemoveObserver() = 0;
       
    66     
       
    67     /**
       
    68      * Returns the rendering session observer
       
    69      *
       
    70      * @since Series 60 3.1     
       
    71      * @param None
       
    72      * @return observer
       
    73      */
       
    74     virtual MUPnPAVRenderingSessionObserver* Observer() const = 0;   
       
    75     
       
    76 public:
       
    77 
       
    78     /**
       
    79      * Set the URI by providing an URI and the item  
       
    80      * 
       
    81      * @since Series 60 3.1
       
    82      * @param aURI URI of the item
       
    83      * @param aObject item
       
    84      */
       
    85     virtual void SetURIL( const TDesC8& aURI, const CUpnpItem& aItem ) = 0;
       
    86     
       
    87     /**
       
    88      * Set the next URI by providing an URI and the item  
       
    89      * 
       
    90      * @since Series 60 3.1
       
    91      * @param aURI URI of the item
       
    92      * @param aObject item
       
    93      */
       
    94     virtual void SetNextURIL( const TDesC8& aURI,
       
    95         const CUpnpItem& aItem ) = 0;
       
    96 
       
    97     /**
       
    98      * Starts the playback. 
       
    99      *
       
   100      * @since Series 60 3.1
       
   101      * @param None
       
   102      * @return none
       
   103      */
       
   104     virtual void PlayL() = 0;
       
   105 
       
   106     /**
       
   107      * Stops the playback.
       
   108      *
       
   109      * @since Series 60 3.1
       
   110      * @param None
       
   111      * @return none
       
   112      */
       
   113     virtual void StopL() = 0;
       
   114 
       
   115     /**
       
   116      * Pauses the playback.
       
   117      *
       
   118      * @since Series 60 3.1
       
   119      * @param None
       
   120      * @return none
       
   121      */
       
   122     virtual void PauseL() = 0;
       
   123 
       
   124     /**
       
   125      * Sets the volume level.
       
   126      *
       
   127      * @since Series 60 3.1
       
   128      * @param aVolumeLevel TInt Volume level in percents (0 - 100)
       
   129      * @return none
       
   130      */
       
   131     virtual void SetVolumeL( TInt aVolumeLevel ) = 0;
       
   132 
       
   133     /**
       
   134      * Gets the volume level.
       
   135      *
       
   136      * @since Series 60 3.1
       
   137      * @param None
       
   138      * @return none
       
   139      */
       
   140     virtual void GetVolumeL() = 0;
       
   141 
       
   142     /**
       
   143      * Sets the mute state.
       
   144      *
       
   145      * @since Series 60 3.1
       
   146      * @param aMute TBool desired state of the mute (ETrue of EFalse)
       
   147      * @return none
       
   148      */
       
   149     virtual void SetMuteL( TBool aMute ) = 0;
       
   150 
       
   151     /**
       
   152      * Gets the mute state.
       
   153      *
       
   154      * @since Series 60 3.1
       
   155      * @param None
       
   156      * @return none
       
   157      */
       
   158     virtual void GetMuteL() = 0;
       
   159 
       
   160     /**
       
   161      * Gets position info of the media that is currently
       
   162      * rendered on the UPnP Media Renderer.
       
   163      *
       
   164      * @since Series 60 3.0
       
   165      * @param none
       
   166      * @return none
       
   167      */
       
   168     virtual void GetPositionInfoL() = 0;
       
   169     
       
   170     };
       
   171 
       
   172 
       
   173 #endif // C_UPNPAVRENDERINGSESSION_H