os/mm/mm_pub/audio_effects_api/inc/MAudioEffectObserver.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description:  Definition of the Audio Effect Observer class.
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
sl@0
    20
#ifndef AUDIOEFFECTOBSERVER_H
sl@0
    21
#define AUDIOEFFECTOBSERVER_H
sl@0
    22
sl@0
    23
// CLASS DECLARATION
sl@0
    24
sl@0
    25
sl@0
    26
/**
sl@0
    27
*  Interface class to be implemented by objects that are interested in receiving events from
sl@0
    28
*  audio effect.
sl@0
    29
*
sl@0
    30
*  @since 3.0
sl@0
    31
*/
sl@0
    32
class MAudioEffectObserver
sl@0
    33
    {
sl@0
    34
    public:
sl@0
    35
sl@0
    36
		static const TUint KEnabled = 1;				// The effect is enabled.
sl@0
    37
		static const TUint KDisabled = 2;				// The effect is disabled
sl@0
    38
		static const TUint KEnforced = 3;				// The effect is enforced
sl@0
    39
		static const TUint KNotEnforced = 4;			// The effect is not enforced
sl@0
    40
		static const TUint KLostUpdateRights = 5;		// The effect has lost update rights
sl@0
    41
		static const TUint KGainedUpdateRights = 6;		// The effect has gained update rights
sl@0
    42
		static const TUint KSpecificEffectBase = 20;	// Offset to specific effect events
sl@0
    43
sl@0
    44
        /**
sl@0
    45
        * Invoked by the audio effect object when the status of the audio effect has changed.
sl@0
    46
        * @since 3.0
sl@0
    47
        * @param aObservedEffect The effect that changed
sl@0
    48
        * @param aEvent The specific event Id of the effect that changed.
sl@0
    49
        */
sl@0
    50
        virtual void EffectChanged( const CAudioEffect* aObservedEffect, TUint8 aEvent ) = 0;
sl@0
    51
sl@0
    52
    };
sl@0
    53
sl@0
    54
#endif      // AUDIOEFFECTOBSERVER_H
sl@0
    55
sl@0
    56
// End of File