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