Symaptic: os/mm/mm_plat/g711_encoder_interface_api/inc/G711EncoderIntfc.h@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2002-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:  Used for interface to G711 encoder.

    15 *

    16 */

    19 #ifndef CG711ENCODERINTFC_H

    20 #define CG711ENCODERINTFC_H

    22 // INCLUDES

    23 #include <e32base.h>

    25 // CONSTANTS

    26 const TUid KUidG711EncoderIntfc = {0x10207AFF};

    28 // MACROS

    30 // DATA TYPES

    32 // FUNCTION PROTOTYPES

    34 // FORWARD DECLARATIONS

    35 class CMMFDevSound;

    36 class CMdaAudioInputStream;

    38 // CLASS DECLARATION

    40 /**

    41 *  Interface for G711 encoder.

    42 *  This abstract class just provides the static NewL function for the creation

    43 *  of the proxy, and also defines the custom interface to be implemented by the

    44 *  proxy and the real custom interface implementation.

    45 *

    46 *  @lib G711EncoderIntfc.lib

    47 *  @since S60 3.0

    48 */

    49 class CG711EncoderIntfc : public CBase

    50 	{

    51     // DATA TYPES

    52     public:

    53         enum TEncodeMode

    54             {

    55             EEncALaw,

    56             EEncULaw

    57             };

    59     public:  // Constructors and destructor

    61         /**

    62         * Creates the interface.

    63         */

    64 		IMPORT_C static CG711EncoderIntfc* NewL(CMMFDevSound& aDevSound);

    66         /**

    67         * Creates the interface.

    68         */

    69 		IMPORT_C static CG711EncoderIntfc* NewL(CMdaAudioInputStream& aUtility);

    71     public: // New functions

    73         /**

    74         * Used to change the encoding mode.

    75         * @since S60 3.0

    76         * @param aEncodeMode requested encode mode.

    77         * @return status

    78         */

    79 		IMPORT_C virtual TInt SetEncoderMode(TEncodeMode aEncodeMode) = 0;

    81         /**

    82         * Enables and disables the voice activity (VAD) mode.

    83         * @since S60 3.0

    84         * @param aVadMode requested VAD mode.

    85         * @return status

    86         */

    87 		IMPORT_C virtual TInt SetVadMode(TBool aVadMode) = 0;

    89         /**

    90         * Retrieves the current state of VAD mode.

    91         * @since S60 3.0

    92         * @param aVadMode returns current VAD mode.

    93         * @return status

    94         */

    95 		IMPORT_C virtual TInt GetVadMode(TBool& aVadMode) = 0;

    98     public: // Functions from base classes

    99     protected:  // New functions

   100     protected:  // Functions from base classes

   101     private:

   103     public:     // Data

   104     protected:  // Data

   105     private:    // Data

   106     public:     // Friend classes

   107     protected:  // Friend classes

   108     private:    // Friend classes

   110 	};

   112 #endif      // CG711ENCODERINTFC_H

   114 // End of File

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--