ipappsrv_plat/media_control_api/inc/mmccctrlobserver.h
changeset 0 1bce908db942
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     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:    Observer class for events.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef MMCCCTRLOBSERVER_H
       
    22 #define MMCCCTRLOBSERVER_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32def.h>
       
    26 #include <mmf/common/mmfbase.h>
       
    27 #include <mmccevents.h>
       
    28 
       
    29 /**
       
    30 *  Observer interface for clients to receive events from MCC.
       
    31 *
       
    32 *  @lib mmccinterface.lib
       
    33 */
       
    34 class MMccCtrlObserver
       
    35     {
       
    36 public:
       
    37     
       
    38     /**
       
    39     * Callback function to receive media events
       
    40     * @param aSignal Received media events
       
    41     * @return void
       
    42     */
       
    43     virtual void MccEventReceived( const TMccEvent& aEvent ) = 0;
       
    44     
       
    45     /**
       
    46     * Callback function to receive media started event.
       
    47     * @param aSessionId Session ID
       
    48     * @param aLinkId Link ID
       
    49     * @param aStreamId Stream ID
       
    50     * @param aSinkSourceId Sink or source ID
       
    51     */
       
    52     virtual void MccMediaStarted( TUint32 aSessionId,
       
    53                                   TUint32 aLinkId,     
       
    54                                   TUint32 aStreamId,
       
    55                                   TUint32 aSinkSourceId ) = 0;
       
    56     
       
    57     /**
       
    58     * Callback function to receive media stopped event.
       
    59     * @param aSessionId Session ID
       
    60     * @param aLinkId Link ID
       
    61     * @param aStreamId Stream ID
       
    62     * @param aSinkSourceId Sink or source ID
       
    63     */
       
    64     virtual void MccMediaStopped( TUint32 aSessionId,
       
    65                                   TUint32 aLinkId,
       
    66                                   TUint32 aStreamId,
       
    67                                   TUint32 aSinkSourceId ) = 0;
       
    68 
       
    69     /**
       
    70     * Callback function to receive media paused event.
       
    71     * @param aSessionId Session ID
       
    72     * @param aLinkId Link ID
       
    73     * @param aStreamId Stream ID
       
    74     * @param aSinkSourceId Sink or source ID
       
    75     */
       
    76     virtual void MccMediaPaused( TUint32 aSessionId,
       
    77                                  TUint32 aLinkId,
       
    78                                  TUint32 aStreamId,
       
    79                                  TUint32 aSinkSourceId ) = 0;
       
    80 
       
    81     /**
       
    82     * Callback function to receive media resumed event.
       
    83     * @param aSessionId Session ID
       
    84     * @param aLinkId Link ID
       
    85     * @param aStreamId Stream ID
       
    86     * @param aSinkSourceId Sink or source ID
       
    87     */
       
    88     virtual void MccMediaResumed( TUint32 aSessionId,
       
    89                                   TUint32 aLinkId,
       
    90                                   TUint32 aStreamId,
       
    91                                   TUint32 aSinkSourceId ) = 0;
       
    92 
       
    93     /**
       
    94     * Callback function to receive media prepared event.
       
    95     * @param aSessionId Session ID
       
    96     * @param aLinkId Link ID
       
    97     * @param aStreamId Stream ID
       
    98     * @param aSinkSourceId Sink or source ID
       
    99     */
       
   100     virtual void MccMediaPrepared( TUint32 aSessionId,
       
   101                                    TUint32 aLinkId,
       
   102                                    TUint32 aStreamId,
       
   103                                    TUint32 aSinkSourceId ) = 0;
       
   104 
       
   105     /**
       
   106     * Callback function to receive media inactivity event.
       
   107     * @param aSessionId Session ID
       
   108     * @param aLinkId Link ID
       
   109     * @param aStreamId Stream ID
       
   110     * @param aSinkSourceId Sink or source ID
       
   111     */
       
   112     virtual void MccMediaInactive( TUint32 aSessionId,
       
   113                                    TUint32 aLinkId,
       
   114                                    TUint32 aStreamId,
       
   115                                    TUint32 aSinkSourceId ) = 0;
       
   116 
       
   117     /**
       
   118     * Callback function to receive media activity event. The
       
   119     * function is called when the first RTP packet is received
       
   120     * by a downlink stream.
       
   121     * @param aSessionId Session ID
       
   122     * @param aLinkId Link ID
       
   123     * @param aStreamId Stream ID
       
   124     * @param aSinkSourceId Sink or source ID
       
   125     */
       
   126     virtual void MccMediaActive( TUint32 aSessionId,
       
   127                                  TUint32 aLinkId,
       
   128                                  TUint32 aStreamId,
       
   129                                  TUint32 aSinkSourceId ) = 0;
       
   130 
       
   131     
       
   132     /**
       
   133     * Callback function to receive error event.
       
   134     * @param aError Error code
       
   135     * @param aSessionId Session ID
       
   136     * @param aLinkId Link ID
       
   137     * @param aSinkSourceId Sink or source ID
       
   138     */
       
   139     virtual void MccCtrlError( TInt aError,
       
   140                                TUint32 aSessionId,
       
   141                                TUint32 aLinkId,
       
   142                                TUint32 aStreamId,
       
   143                                TUint32 aSinkSourceId ) = 0;
       
   144     
       
   145     
       
   146     /**
       
   147      * Callback function to notify client of unknown media packet.
       
   148      * Called when packet with unknown payload type is 
       
   149      * received by a downlink stream.
       
   150      *
       
   151      * @since Series 60 3.0
       
   152      * @param aSessionId Session ID
       
   153      * @param aLinkId Link ID
       
   154      * @param aStreamId Stream ID
       
   155      * @param aSinkSourceId Sink or source ID
       
   156      * @param aPayloadType Payload type of received packet
       
   157      * @return void
       
   158      */
       
   159     inline virtual void UnknownMediaReceived( TUint32 /*aSessionId*/,
       
   160                                        TUint32 /*aLinkId*/,
       
   161                                        TUint32 /*aStreamId*/,
       
   162                                        TUint32 /*aSinkSourceId*/,
       
   163                                        TUint8 /*aPayloadType*/ ){};                           
       
   164 };
       
   165     
       
   166 #endif    // MMCCCTRLOBSERVER_H