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