mmmw_plat/telephony_multimedia_service_api/inc/tmsg729format.h
changeset 0 71ca22bcf22a
child 18 2eb3b066cc7d
equal deleted inserted replaced
-1:000000000000 0:71ca22bcf22a
       
     1 /*
       
     2  * Copyright (c) 2009 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: Telephony Multimedia Service
       
    15  *
       
    16  */
       
    17 
       
    18 #ifndef TMS_G729_FORMAT_H
       
    19 #define TMS_G729_FORMAT_H
       
    20 
       
    21 #include <tms.h>
       
    22 #include <tmsformat.h>
       
    23 
       
    24 namespace TMS {
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class TMSG729FormatBody;
       
    28 
       
    29 /**
       
    30  * TMSG729Format class
       
    31  *
       
    32  * This class provides access methods to configure and query G.729 codec
       
    33  * format settings.
       
    34  *
       
    35  * This format class can be used for both the encoder and decoder.
       
    36  *
       
    37  * @lib tmsapi.lib
       
    38  *
       
    39  */
       
    40 class TMSG729Format : public TMSFormat
       
    41     {
       
    42 public:
       
    43     /**
       
    44      * Destructor
       
    45      */
       
    46     IMPORT_C virtual ~TMSG729Format();
       
    47 
       
    48     /**
       
    49      * Toggles on and off Voice Activation Detection (VAD) for G.729 encoder.
       
    50      * Not supported by the decoder.
       
    51      *
       
    52      * This method is allowable at all times, while actively encoding or not.
       
    53      *
       
    54      * @param  vad
       
    55      *      Sets VAD feature on or off.
       
    56      *
       
    57      * @return
       
    58      *      TMS_RESULT_SUCCESS if the operation was successful.
       
    59      *      TMS_RESULT_FEATURE_NOT_SUPPORTED if this method is not implemented
       
    60      *      by the adaptation.
       
    61      *      TMS_RESULT_DOES_NOT_EXIST if the custom interface handle does
       
    62      *      not exist.
       
    63      *
       
    64      */
       
    65     IMPORT_C gint SetVADMode(const gboolean vad);
       
    66 
       
    67     /**
       
    68      * Returns current VAD setting of the G.729 encoder.
       
    69      *
       
    70      * This method is allowable at all times, while actively encoding or not.
       
    71      *
       
    72      * @param  vad
       
    73      *      Current VAD setting of the encoder.
       
    74      *
       
    75      * @return
       
    76      *      TMS_RESULT_SUCCESS if the operation was successful.
       
    77      *
       
    78      */
       
    79     IMPORT_C gint GetVADMode(gboolean& vad);
       
    80 
       
    81 protected:
       
    82     /**
       
    83      * Constructor
       
    84      */
       
    85     IMPORT_C TMSG729Format();
       
    86 
       
    87 protected:
       
    88     TMSG729FormatBody *iBody;
       
    89     };
       
    90 
       
    91 } //namespace TMS
       
    92 
       
    93 #endif //TMS_G729_FORMAT_H