os/mm/mm_plat/global_audio_settings_api/inc/MGlobalAudioSettingsObserver.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mm_plat/global_audio_settings_api/inc/MGlobalAudioSettingsObserver.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,74 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  This file contains definitions of GlobalAudioSettings observer.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +#ifndef MGLOBALAUDIOSETTINGSOBSERVER_H
    1.24 +#define MGLOBALAUDIOSETTINGSOBSERVER_H
    1.25 +
    1.26 +// CONSTANTS
    1.27 +
    1.28 +// CLASS DECLARATION
    1.29 +
    1.30 +/**
    1.31 + *  An interface to Global Audio Settings observer callback functions.
    1.32 + *
    1.33 + *  This serves as the method of communication between the client and the
    1.34 + *  CGlobalAudioSettings object.
    1.35 + *
    1.36 + *  The class is a mixin and is intended to be inherited by the client class
    1.37 + *  that is interested in observing the global audio settings. The functions
    1.38 + *  encapsulated by this class are called when events occur which causes device
    1.39 + *  audio settings to be changed that affects the overall audio behavior.
    1.40 + *
    1.41 + *  @lib GlobalAudioSettings.lib
    1.42 + *  @since 3.2
    1.43 + */
    1.44 +class MAudioSettingsObserver
    1.45 +    {
    1.46 +public:
    1.47 +    enum TGASEventId
    1.48 +        {
    1.49 +          EGASWarningTones,
    1.50 +          EGASMessageTones,
    1.51 +          EGASSilentProfile,
    1.52 +          EGASVibra,
    1.53 +          EGASMessageToneName,
    1.54 +          EGASEmailToneName,
    1.55 +          EGASRingingType,
    1.56 +          EGASVideoCallToneName,
    1.57 +          EGASRingingTone1Name,
    1.58 +          EGASRingingTone2Name,
    1.59 +          EGASKeyPadVolume,
    1.60 +          EGASSilenceMode
    1.61 +        };
    1.62 +
    1.63 +public:
    1.64 +    /**
    1.65 +    * Invoked by the Global Audio Settings object when audio setting has changed.
    1.66 +    *
    1.67 +    * @since 3.2
    1.68 +    * @param CGlobalAudioSettings& A reference to Global Audio Settings object
    1.69 +    *   which invoked the callback.
    1.70 +    * @param aSetting Specific id of the audio setting that changed.
    1.71 +    */
    1.72 +    virtual void SettingsChanged(CGlobalAudioSettings& aGlobalAudioSettings, TGASEventId aSetting) = 0;
    1.73 +    };
    1.74 +
    1.75 +#endif      // MGLOBALAUDIOSETTINGSOBSERVER_H
    1.76 +
    1.77 +// End of File