mmserv/tms/tmscallserver/inc/tmsdtmfprovider.h
changeset 22 128eb6a32b84
parent 14 80975da52420
equal deleted inserted replaced
16:43d09473c595 22:128eb6a32b84
    18 #ifndef TMSDTMFPROVIDER_H
    18 #ifndef TMSDTMFPROVIDER_H
    19 #define TMSDTMFPROVIDER_H
    19 #define TMSDTMFPROVIDER_H
    20 
    20 
    21 #include <e32base.h>
    21 #include <e32base.h>
    22 #include <etelmm.h>
    22 #include <etelmm.h>
       
    23 #include <glib.h>
    23 #include <rmmcustomapi.h>
    24 #include <rmmcustomapi.h>
    24 #include "tmsdtmfobserver.h"
    25 #include "tmsdtmfobserver.h"
    25 
    26 
    26 namespace TMS {
    27 namespace TMS {
    27 
    28 
    57      * @param aEvent Event type
    58      * @param aEvent Event type
    58      * @param aError Error code
    59      * @param aError Error code
    59      * @param aTone Character
    60      * @param aTone Character
    60      */
    61      */
    61     void NotifyDTMFEvent(const TMSDTMFObserver::TCCPDtmfEvent aEvent,
    62     void NotifyDTMFEvent(const TMSDTMFObserver::TCCPDtmfEvent aEvent,
    62             const TInt aError, const TChar aTone);
    63             const gint aError, const TChar aTone);
    63 
    64 
    64     // from base class MCCPDTMFProvider
    65     // from base class MCCPDTMFProvider
    65     /**
    66     /**
    66      * Cancels asynchronous DTMF string sending.
    67      * Cancels asynchronous DTMF string sending.
    67      * @return KErrNone if succesfull, otherwise another system wide error code
    68      * @return KErrNone if succesfull, otherwise another system wide error code
    68      */
    69      */
    69     TInt CancelDtmfStringSending();
    70     gint CancelDtmfStringSending();
    70 
    71 
    71     /**
    72     /**
    72      * Starts the transmission of a single DTMF tone across a
    73      * Starts the transmission of a single DTMF tone across a
    73      * connected and active call.
    74      * connected and active call.
    74      * @param aTone Tone to be played.
    75      * @param aTone Tone to be played.
    75      * @return KErrNone if succesfull, otherwise another system wide error code
    76      * @return KErrNone if succesfull, otherwise another system wide error code
    76      */
    77      */
    77     TInt StartDtmfTone(const TChar aTone);
    78     gint StartDtmfTone(const TChar aTone);
    78 
    79 
    79     /**
    80     /**
    80      * Stops playing current DTMF tone.
    81      * Stops playing current DTMF tone.
    81      * @return KErrNone if succesfull, otherwise another system wide error code
    82      * @return KErrNone if succesfull, otherwise another system wide error code
    82      */
    83      */
    83     TInt StopDtmfTone();
    84     gint StopDtmfTone();
    84 
    85 
    85     /**
    86     /**
    86      * Plays DTMF string.
    87      * Plays DTMF string.
    87      * @param aString String to be played.
    88      * @param aString String to be played.
    88      * @return KErrNone if succesfull, otherwise another system wide error code
    89      * @return KErrNone if succesfull, otherwise another system wide error code
    89      * KErrArgument if the specified string contains illegal DTMF characters
    90      * KErrArgument if the specified string contains illegal DTMF characters
    90      */
    91      */
    91     TInt SendDtmfToneString(const TDesC& aString);
    92     gint SendDtmfToneString(const TDesC& aString);
    92 
    93 
    93     /**
    94     /**
    94      * Continue or cancel sending DTMF string which was stopped with 'w'
    95      * Continue or cancel sending DTMF string which was stopped with 'w'
    95      * character in string.
    96      * character in string.
    96      * @param aContinue ETrue if sending of the DTMF string should continue,
    97      * @param aContinue ETrue if sending of the DTMF string should continue,
    97      * EFalse if the rest of the DTMF string is to be discarded.
    98      * EFalse if the rest of the DTMF string is to be discarded.
    98      * @return KErrNone if succesfull, otherwise another system wide error code
    99      * @return KErrNone if succesfull, otherwise another system wide error code
    99      */
   100      */
   100     TInt ContinueDtmfStringSending(const TBool aContinue);
   101     gint ContinueDtmfStringSending(const gboolean aContinue);
   101 
   102 
   102     /**
   103     /**
   103      * Add an observer for DTMF related events.
   104      * Add an observer for DTMF related events.
   104      * Plug-in dependent feature if duplicates or more than one observers
   105      * Plug-in dependent feature if duplicates or more than one observers
   105      * are allowed or not. Currently CCE will set only one observer.
   106      * are allowed or not. Currently CCE will set only one observer.
   106      * @param aObserver Observer
   107      * @param aObserver Observer
   107      * @leave system error if observer adding fails
   108      * @leave system error if observer adding fails
   108      */
   109      */
   109     void AddObserverL(const TMSDTMFObserver& aObserver);
   110     void AddObserver(const TMSDTMFObserver& aObserver);
   110 
   111 
   111     /**
   112     /**
   112      * Remove an observer.
   113      * Remove an observer.
   113      * @param aObserver Observer
   114      * @param aObserver Observer
   114      * @return KErrNone if removed succesfully. KErrNotFound if observer was
   115      * @return KErrNone if removed succesfully. KErrNotFound if observer was
   115      * not found. Any other system error depending on the error.
   116      * not found. Any other system error depending on the error.
   116      */
   117      */
   117     TInt RemoveObserver(const TMSDTMFObserver& aObserver);
   118     gint RemoveObserver(const TMSDTMFObserver& aObserver);
   118 
   119 
   119     // from base class CActive
   120     // from base class CActive
   120 protected:
   121 protected:
   121     /**
   122     /**
   122      * From CActive
   123      * From CActive