phoneengine/audiohandling/inc/cpeaudioeffect.h
changeset 27 2f8f8080a020
equal deleted inserted replaced
22:6bb1b21d2484 27:2f8f8080a020
       
     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: Audio Effects handler
       
    15  *
       
    16  */
       
    17 
       
    18 #ifndef CPEAUDIOEFFECT_H
       
    19 #define CPEAUDIOEFFECT_H
       
    20 
       
    21 #include <e32base.h>
       
    22 #include <tmseffectobsrvr.h>
       
    23 
       
    24 namespace TMS {
       
    25 //FORWARD DECLARATIONS
       
    26 class TMSFactory;
       
    27 } //namespace TMS
       
    28 
       
    29 using namespace TMS;
       
    30 
       
    31 /**
       
    32  *  Starts and stops TMS audio streams.
       
    33  *  If the activation fails then there is a retry timer which
       
    34  *  will try the activation later.
       
    35  */
       
    36 NONSHARABLE_CLASS(CPEAudioEffect) : public CBase
       
    37     {
       
    38 public:
       
    39 
       
    40     /**
       
    41      * Two-phased constructing.
       
    42      */
       
    43     static CPEAudioEffect* NewL(TMSEffectObserver& aObserver);
       
    44 
       
    45     /**
       
    46      * Two-phased constructing.
       
    47      */
       
    48     static CPEAudioEffect* NewLC(TMSEffectObserver& aObserver);
       
    49 
       
    50     /**
       
    51      * C++ default destructor.
       
    52      */
       
    53     virtual ~CPEAudioEffect();
       
    54 
       
    55     /**
       
    56      * Set muted.
       
    57      */
       
    58     TInt SetMuteState(TBool aMute);
       
    59     /**
       
    60      * Get mute.
       
    61      */
       
    62     TBool MuteState() const;
       
    63 
       
    64     /**
       
    65      * Set volume.
       
    66      */
       
    67     void SetVolume(TInt aVolume);
       
    68 
       
    69     /**
       
    70      * Get volume.
       
    71      */
       
    72     TInt Volume() const;
       
    73 
       
    74 public:
       
    75     // Functions from base classes
       
    76 
       
    77 private:
       
    78 
       
    79     /**
       
    80      * C++ default constructor.
       
    81      */
       
    82     CPEAudioEffect();
       
    83 
       
    84     void ConstructL(TMSEffectObserver& aObserver);
       
    85 
       
    86 private:
       
    87     // data
       
    88     TMSFactory* iFactory;
       
    89     TMSEffect* iGlobalVol;
       
    90     TMSEffect* iGlobalGain;
       
    91     };
       
    92 
       
    93 #endif // CPEAUDIOEFFECT_H