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