ipappsrv_plat/multimedia_comms_api/inc/mcedtmfobserver.h
changeset 0 1bce908db942
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     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:    
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef MMCEDTMFOBSERVER_H
       
    22 #define MMCEDTMFOBSERVER_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32base.h>
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class CMceSession;
       
    29 class CMceAudioStream;
       
    30 class CMceMediaSource;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35 *  An interface to be implemented by users of MCE if they wish to receive
       
    36 *  DTMF related notifications.
       
    37 *
       
    38 *  @lib mceclient.lib
       
    39 */
       
    40 class MMceDtmfObserver
       
    41     {    
       
    42     public:
       
    43     
       
    44         enum TMceDtmfEvent
       
    45             {
       
    46             EDtmfSendStarted,
       
    47             EDtmfSendCompleted
       
    48             };
       
    49     
       
    50     public: // New functions
       
    51 
       
    52         /**
       
    53         * Incoming DTMF tone received.
       
    54         * @param aSession Session that tone was received.
       
    55         * @param aStream Stream that tone was received.
       
    56         * @param aTone Received tone.
       
    57         */
       
    58         virtual void DtmfToneReceived( CMceSession& aSession,
       
    59                                        CMceAudioStream& aStream,
       
    60                                        const TChar& aTone ) = 0;
       
    61         
       
    62         /**
       
    63         * DTMF event received.
       
    64         * @param aSession Session that event was received.
       
    65         * @param aStream Stream that event was received.
       
    66         * @param aSource Source that event was received.
       
    67         * @param aEvent Received event.
       
    68         */
       
    69         virtual void DtmfEventReceived( CMceSession& aSession,
       
    70                                         CMceAudioStream& aStream,
       
    71                                         CMceMediaSource& aSource,
       
    72                                         TMceDtmfEvent aEvent ) = 0;
       
    73                                       		
       
    74         /**
       
    75         * DTMF error occured. If error occurs, DTMFs becomes
       
    76         * unavailable for that source.
       
    77         * @param aSession Session that event was received.
       
    78         * @param aStream Stream that event was received.
       
    79         * @param aStream Stream that event was received.
       
    80         * @param aError Error code.
       
    81         */
       
    82         virtual void DtmfErrorOccured( CMceSession& aSession,
       
    83                                        CMceAudioStream& aStream,
       
    84                                        CMceMediaSource& aSource,
       
    85                                        TInt aError ) = 0;
       
    86     };
       
    87 
       
    88 #endif