radioengine/settings/api/mradiosettingssetter.h
branchRCL_3
changeset 20 93c594350b9a
parent 19 cce62ebc198e
equal deleted inserted replaced
19:cce62ebc198e 20:93c594350b9a
     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:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef M_RADIOSETTINGSSETTERS_H
       
    19 #define M_RADIOSETTINGSSETTERS_H
       
    20 
       
    21 // User includes
       
    22 #include "mradioenginesettings.h"
       
    23 
       
    24 // Forward declarations
       
    25 class MRadioSettingsObserver;
       
    26 
       
    27 /**
       
    28  * Setter interface for radio settings. This should be accessible only for CRadioEngineImp
       
    29  */
       
    30 NONSHARABLE_CLASS( MRadioSettingsSetter ) : public MRadioEngineSettings
       
    31     {
       
    32 public:
       
    33 
       
    34     /**
       
    35      * Sets observer for the radio settings
       
    36      *
       
    37      * @param aObserver The observer
       
    38      */
       
    39     virtual void SetObserver( MRadioSettingsObserver* aObserver ) = 0;
       
    40 
       
    41     /**
       
    42      * Stores the radio volume level that is used when audio is routed through the headset.
       
    43      *
       
    44      * @param    aVolume     The radio volume level to store.
       
    45      *
       
    46      */
       
    47     virtual TInt SetHeadsetVolume( TInt aVolume ) = 0;
       
    48 
       
    49     /**
       
    50      * Stores the radio volume level that is used when audio is routed through the speaker.
       
    51      *
       
    52      * @param   aVolume     The radio volume level.
       
    53      */
       
    54     virtual TInt SetSpeakerVolume( TInt aVolume ) = 0;
       
    55 
       
    56     /**
       
    57      * Wrapper for storing the radio volume level of current output device
       
    58      *
       
    59      * @param   aVolume     The radio volume level.
       
    60      */
       
    61     virtual TInt SetVolume( TInt aVolume ) = 0;
       
    62 
       
    63     /**
       
    64      * Stores the radio output mode to use.
       
    65      *
       
    66      * @param   aOutputMode     The radio output mode to use.
       
    67      */
       
    68     virtual TInt SetOutputMode( TInt aOutputMode ) = 0;
       
    69 
       
    70     /**
       
    71      * Stores the radio audio route ( headset/ihf ) to use.
       
    72      *
       
    73      * @param   aAudioRoute   The radio output destination to use.
       
    74      */
       
    75     virtual TInt SetAudioRoute( TInt aAudioRoute ) = 0;
       
    76 
       
    77     /**
       
    78      * Stores the radio muting state when audio is routed through the headset.
       
    79      *
       
    80      * @param   aMuted      <code>ETrue</code> if radio is to be muted when routed through the headset, <code>EFalse</code> otherwise.
       
    81      */
       
    82     virtual TInt SetHeadsetVolMuted( TBool aMuted ) = 0;
       
    83 
       
    84     /**
       
    85      * Stores the radio muting state when audio is routed through the speaker.
       
    86      *
       
    87      * @param   aMuted      <code>ETrue</code> if radio is to be muted when routed through the speaker, <code>EFalse</code> otherwise.
       
    88      */
       
    89     virtual TInt SetSpeakerVolMuted( TBool aMuted ) = 0;
       
    90 
       
    91     /**
       
    92      * Wrapper for storing the radio muting state of current output device
       
    93      *
       
    94      * @param   aMuted      <code>ETrue</code> if radio is to be muted, <code>EFalse</code> otherwise.
       
    95      */
       
    96     virtual TInt SetVolMuted( TBool aMuted ) = 0;
       
    97 
       
    98     /**
       
    99      * Stores the power state of the radio.
       
   100      *
       
   101      * @param   aPowerState     <code>ETrue</code> if radio is powered on, <code>EFalse</code> otherwise.
       
   102      */
       
   103     virtual TInt SetPowerOn( TBool aPowerState ) = 0;
       
   104 
       
   105     /**
       
   106      * Stores the frequency tuned.
       
   107      *
       
   108      * @param   aFrequency  The frequency to store.
       
   109      */
       
   110     virtual TInt SetTunedFrequency( TUint32 aFrequency ) = 0;
       
   111 
       
   112     /**
       
   113      * Stores the region ID currently in use.
       
   114      *
       
   115      * @param   aRegion     The region's ID to store.
       
   116      */
       
   117     virtual TInt SetRegionId( TInt aRegion ) = 0;
       
   118 
       
   119     /**
       
   120      *
       
   121      */
       
   122     virtual TInt SetNetworkId( const TDesC& aNetworkId ) = 0;
       
   123 
       
   124     /**
       
   125      *
       
   126      */
       
   127     virtual TInt SetCountryCode( const TDesC& aCountryCode ) = 0;
       
   128 
       
   129     };
       
   130 
       
   131 #endif // M_RADIOSETTINGSSETTERS_H