os/mm/mm_plat/speech_encoder_config_api/inc/SpeechEncoderConfig.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies). 
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description:  Used to configure the speech encoders.
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
#ifndef CSPEECHENCODERCONFIG_H
sl@0
    20
#define CSPEECHENCODERCONFIG_H
sl@0
    21
sl@0
    22
// INCLUDES
sl@0
    23
#include <e32base.h>
sl@0
    24
sl@0
    25
// CONSTANTS
sl@0
    26
const TUid KUidSpeechEncoderConfig = {0x10207AB2};
sl@0
    27
sl@0
    28
// MACROS
sl@0
    29
sl@0
    30
// DATA TYPES
sl@0
    31
sl@0
    32
// FUNCTION PROTOTYPES
sl@0
    33
sl@0
    34
// FORWARD DECLARATIONS
sl@0
    35
class CMMFDevSound;
sl@0
    36
class CMdaAudioInputStream;
sl@0
    37
sl@0
    38
// CLASS DECLARATION
sl@0
    39
sl@0
    40
/**
sl@0
    41
*  Interface for configuring speech encoders.
sl@0
    42
*  Used to configure the speech encoders operting modes.
sl@0
    43
*  This abstract class just provides the static NewL function for the creation
sl@0
    44
*  of the proxy, and also defines the custom interface to be implemented by the
sl@0
    45
*  proxy and the real custom interface implementation.
sl@0
    46
*
sl@0
    47
*  @lib SpeechEncoderConfig.lib
sl@0
    48
*  @since S60 3.0
sl@0
    49
*/
sl@0
    50
class CSpeechEncoderConfig : public CBase
sl@0
    51
	{
sl@0
    52
    public:  // Constructors and destructor
sl@0
    53
        
sl@0
    54
        /**
sl@0
    55
        * Creates the interface.
sl@0
    56
        */
sl@0
    57
		IMPORT_C static CSpeechEncoderConfig* 
sl@0
    58
		                NewL(CMMFDevSound& aDevSound);
sl@0
    59
sl@0
    60
        /**
sl@0
    61
        * Creates the interface.
sl@0
    62
        */
sl@0
    63
		IMPORT_C static CSpeechEncoderConfig* 
sl@0
    64
		                NewL(CMdaAudioInputStream& aUtility);
sl@0
    65
        
sl@0
    66
    public: // New functions
sl@0
    67
        /**
sl@0
    68
        * Retrieves the bitrates supported by the encoder.
sl@0
    69
        * @since S60 3.0
sl@0
    70
        * @param aSupportedBitrates array returning the supported bitrates.
sl@0
    71
        * @return status
sl@0
    72
        */
sl@0
    73
		IMPORT_C virtual TInt GetSupportedBitrates(
sl@0
    74
		                      RArray<TUint>& aSupportedBitrates) = 0;
sl@0
    75
sl@0
    76
        /**
sl@0
    77
        * Sets the bitrate for encoding.
sl@0
    78
        * @since S60 3.0
sl@0
    79
        * @param aBitrate requested encoding bitrate.
sl@0
    80
        * @return status
sl@0
    81
        */
sl@0
    82
		IMPORT_C virtual TInt SetBitrate(TUint aBitrate) = 0;
sl@0
    83
sl@0
    84
        /**
sl@0
    85
        * Retrieves the current encode bitrate.
sl@0
    86
        * @since S60 3.0
sl@0
    87
        * @param aBitrate returns current encode bitrate.
sl@0
    88
        * @return status
sl@0
    89
        */
sl@0
    90
		IMPORT_C virtual TInt GetBitrate(TUint& aBitrate) = 0;
sl@0
    91
sl@0
    92
        /**
sl@0
    93
        * Enables and disables the voice activity (VAD) mode.
sl@0
    94
        * @since S60 3.0
sl@0
    95
        * @param aVadMode requested VAD mode.
sl@0
    96
        * @return status
sl@0
    97
        */
sl@0
    98
		IMPORT_C virtual TInt SetVadMode(TBool aVadMode) = 0;
sl@0
    99
sl@0
   100
        /**
sl@0
   101
        * Retrieves the current state of VAD mode.
sl@0
   102
        * @since S60 3.0
sl@0
   103
        * @param aVadMode returns current VAD mode.
sl@0
   104
        * @return status
sl@0
   105
        */
sl@0
   106
		IMPORT_C virtual TInt GetVadMode(TBool& aVadMode) = 0;
sl@0
   107
        
sl@0
   108
    public: // Functions from base classes
sl@0
   109
    protected:  // New functions
sl@0
   110
    protected:  // Functions from base classes
sl@0
   111
    private:
sl@0
   112
sl@0
   113
    public:     // Data
sl@0
   114
    protected:  // Data
sl@0
   115
    private:    // Data
sl@0
   116
    public:     // Friend classes
sl@0
   117
    protected:  // Friend classes
sl@0
   118
    private:    // Friend classes
sl@0
   119
sl@0
   120
	};
sl@0
   121
sl@0
   122
#endif      // CSPEECHENCODERCONFIG_H
sl@0
   123
            
sl@0
   124
// End of File