epoc32/include/maudioeffectobserver.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Definition of the Audio Effect Observer class.
*
*/



#ifndef AUDIOEFFECTOBSERVER_H
#define AUDIOEFFECTOBSERVER_H

// CLASS DECLARATION


/**
*  Interface class to be implemented by objects that are interested in receiving events from
*  audio effect.
*
*  @since 3.0
*/
class MAudioEffectObserver
    {
    public:

		static const TUint KEnabled = 1;				// The effect is enabled.
		static const TUint KDisabled = 2;				// The effect is disabled
		static const TUint KEnforced = 3;				// The effect is enforced
		static const TUint KNotEnforced = 4;			// The effect is not enforced
		static const TUint KLostUpdateRights = 5;		// The effect has lost update rights
		static const TUint KGainedUpdateRights = 6;		// The effect has gained update rights
		static const TUint KSpecificEffectBase = 20;	// Offset to specific effect events

        /**
        * Invoked by the audio effect object when the status of the audio effect has changed.
        * @since 3.0
        * @param aObservedEffect The effect that changed
        * @param aEvent The specific event Id of the effect that changed.
        */
        virtual void EffectChanged( const CAudioEffect* aObservedEffect, TUint8 aEvent ) = 0;

    };

#endif      // AUDIOEFFECTOBSERVER_H

// End of File