epoc32/include/maudioeffectobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Definition of the Audio Effect Observer class.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef AUDIOEFFECTOBSERVER_H
williamr@2
    21
#define AUDIOEFFECTOBSERVER_H
williamr@2
    22
williamr@2
    23
// CLASS DECLARATION
williamr@2
    24
williamr@2
    25
williamr@2
    26
/**
williamr@2
    27
*  Interface class to be implemented by objects that are interested in receiving events from
williamr@2
    28
*  audio effect.
williamr@2
    29
*
williamr@2
    30
*  @since 3.0
williamr@2
    31
*/
williamr@2
    32
class MAudioEffectObserver
williamr@2
    33
    {
williamr@2
    34
    public:
williamr@2
    35
williamr@2
    36
		static const TUint KEnabled = 1;				// The effect is enabled.
williamr@2
    37
		static const TUint KDisabled = 2;				// The effect is disabled
williamr@2
    38
		static const TUint KEnforced = 3;				// The effect is enforced
williamr@2
    39
		static const TUint KNotEnforced = 4;			// The effect is not enforced
williamr@2
    40
		static const TUint KLostUpdateRights = 5;		// The effect has lost update rights
williamr@2
    41
		static const TUint KGainedUpdateRights = 6;		// The effect has gained update rights
williamr@2
    42
		static const TUint KSpecificEffectBase = 20;	// Offset to specific effect events
williamr@2
    43
williamr@2
    44
        /**
williamr@2
    45
        * Invoked by the audio effect object when the status of the audio effect has changed.
williamr@2
    46
        * @since 3.0
williamr@2
    47
        * @param aObservedEffect The effect that changed
williamr@2
    48
        * @param aEvent The specific event Id of the effect that changed.
williamr@2
    49
        */
williamr@2
    50
        virtual void EffectChanged( const CAudioEffect* aObservedEffect, TUint8 aEvent ) = 0;
williamr@2
    51
williamr@2
    52
    };
williamr@2
    53
williamr@2
    54
#endif      // AUDIOEFFECTOBSERVER_H
williamr@2
    55
williamr@2
    56
// End of File