1 /*

     2  * Copyright (c) 2010 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: QT Bindings for TMS

    15  *

    16  */

    17 

    18 #ifndef QTMS_DTMF_H

    19 #define QTMS_DTMF_H

    20 

    21 #include <qtms.h>

    22 #include <QObject>

    23 #include "qtmswrapperexport.h"

    24 

    25 // FORWARD DECLARATIONS

    26 namespace TMS

    27 {

    28 class TMSDTMF;

    29 }

    30 

    31 namespace QTMS

    32 {

    33 

    34 /**

    35  * QTMSDTMFclass

    36  *

    37  * This class provides DTMF playback capability to the QTMS clients. Each

    38  * DTMF player session is associated either with an uplink or downlink stream.

    39  *

    40  * @lib QTMSapi.lib

    41  *

    42  */

    43 class QTMS_WRAPPER_DLL_EXPORT QTMSDTMF : public QObject

    44 {

    45     Q_OBJECT

    46 public:

    47     /**

    48      * Destructor

    49      */

    50     virtual ~QTMSDTMF();

    51 

    52     /**

    53      * Starts DTMF playback. In the case of downlink, the tone will be played

    54      * locally. In case of uplink, the network will play tones.

    55      *

    56      * Common for CS and VOIP (uplink and downlink)

    57      *

    58      * @return

    59      *      QTMS_RESULT_SUCCESS if the operation was successful.

    60      *

    61      */

    62     gint Start();

    63 

    64     /**

    65      * Stops DTMF playback.

    66      * Common for CS and VOIP (Uplink and Downlink).

    67      *

    68      * @return

    69      *      QTMS_RESULT_SUCCESS if the operation was successful.

    70      *

    71      */

    72     gint Stop();

    73 

    74     /**

    75      * Supply DTMF player with a string of tones to be played on local

    76      * playback device or sent via the uplink.

    77      *

    78      * @param  string

    79      *      String containing one or more DTMF digits.

    80      *

    81      * @return

    82      *      QTMS_RESULT_SUCCESS if the operation was successful.

    83      *

    84      */

    85     gint SetTone(GString* string);

    86 

    87     /**

    88      *  Allows a client to continue or cancel the sending of a DTMF string

    89      *  when it was stopped by the use of ‘w’ char in the string.

    90      *  The client will set sending param to true if it wishes to continue

    91      *  the DTMF string sending and will set sending param to false if it

    92      *  wishes to discard the rest of the DTMF string.

    93      *  Reference: Multimode ETel API Design Document

    94      *

    95      *  For CS calltype

    96      *

    97      *  @param  sending

    98      *      Boolean to continue sending DTMF string.

    99      *

   100      * @return

   101      *      QTMS_RESULT_SUCCESS if the operation was successful.

   102      *

   103      */

   104     gint ContinueDTMFStringSending(gboolean sending);

   105 

   106     Q_SIGNALS:

   107     void DTMFEvent(const QTMSDTMF& dtmf, QTMSSignalEvent event);

   108 

   109 protected:

   110 

   111     /**

   112      * Constructor

   113      */

   114     QTMSDTMF();

   115 

   116 protected:

   117     TMS::TMSDTMF* iDtmf;

   118 };

   119 

   120 } //namespace QTMS

   121 

   122 #endif //__QTMS_DTMF_H__

   123 // End of file