1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/mm_pub/audio_effects_api/inc/MAudioEffectObserver.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,56 @@
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: Definition of the Audio Effect Observer class.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +#ifndef AUDIOEFFECTOBSERVER_H
1.24 +#define AUDIOEFFECTOBSERVER_H
1.25 +
1.26 +// CLASS DECLARATION
1.27 +
1.28 +
1.29 +/**
1.30 +* Interface class to be implemented by objects that are interested in receiving events from
1.31 +* audio effect.
1.32 +*
1.33 +* @since 3.0
1.34 +*/
1.35 +class MAudioEffectObserver
1.36 + {
1.37 + public:
1.38 +
1.39 + static const TUint KEnabled = 1; // The effect is enabled.
1.40 + static const TUint KDisabled = 2; // The effect is disabled
1.41 + static const TUint KEnforced = 3; // The effect is enforced
1.42 + static const TUint KNotEnforced = 4; // The effect is not enforced
1.43 + static const TUint KLostUpdateRights = 5; // The effect has lost update rights
1.44 + static const TUint KGainedUpdateRights = 6; // The effect has gained update rights
1.45 + static const TUint KSpecificEffectBase = 20; // Offset to specific effect events
1.46 +
1.47 + /**
1.48 + * Invoked by the audio effect object when the status of the audio effect has changed.
1.49 + * @since 3.0
1.50 + * @param aObservedEffect The effect that changed
1.51 + * @param aEvent The specific event Id of the effect that changed.
1.52 + */
1.53 + virtual void EffectChanged( const CAudioEffect* aObservedEffect, TUint8 aEvent ) = 0;
1.54 +
1.55 + };
1.56 +
1.57 +#endif // AUDIOEFFECTOBSERVER_H
1.58 +
1.59 +// End of File