javauis/amms_akn/mmacontrol/inc/cammsbasereverbsourcecontrol.h
branchRCL_3
changeset 19 04becd199f91
equal deleted inserted replaced
16:f5050f1da672 19:04becd199f91
       
     1 /*
       
     2 * Copyright (c) 2005 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:  Class behaves like interface of an audio effect reverb source.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CAMMSBASEREVERBSOURCECONTROL_H
       
    20 #define CAMMSBASEREVERBSOURCECONTROL_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "cammscontrol.h"
       
    25 
       
    26 // CONSTANTS
       
    27 _LIT(KAMMSBaseReverbSourceControl, "ReverbSourceControl");
       
    28 
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 *
       
    34 *  Controls for the Reverb Source effect.
       
    35 *  This class delegates Base class of Reverb Source effect method .
       
    36 *
       
    37 *
       
    38 *  @since 5.1
       
    39 */
       
    40 NONSHARABLE_CLASS(CAMMSBaseReverbSourceControl): public CAMMSControl
       
    41 {
       
    42 public:
       
    43 
       
    44     /**
       
    45     * Destructor.
       
    46     */
       
    47     ~CAMMSBaseReverbSourceControl();
       
    48 
       
    49 public:
       
    50     /**
       
    51     * Sets the object specific level for the reverberant sound.
       
    52     * The default value is 0 meaning the natural room gain (set by
       
    53     * ReverbControl's presets).
       
    54     *
       
    55     * @param aLevel The new level of the reverberation in millibels.
       
    56     *
       
    57     * @par Leaving:
       
    58     * @li \c KErrArgument - \a aLevel is greater than 0
       
    59     */
       
    60     virtual void SetRoomLevelL(TInt aLevel) = 0;
       
    61 
       
    62 public:
       
    63 
       
    64     const TDesC& ClassName() const = 0;
       
    65 
       
    66 protected:
       
    67     /**
       
    68     * C++ constructor.
       
    69     * @param aPlayer Player that has this control.
       
    70     * @param aReverbControl Reverb control belonging to aPlayer.
       
    71     */
       
    72     CAMMSBaseReverbSourceControl(CMMAPlayer* aPlayer);
       
    73 
       
    74 };
       
    75 
       
    76 #endif // CAMMSBASEREVERBSOURCECONTROL_H
       
    77 
       
    78