devsound/a3facf/inc/maudioprocessingunitobserver.h
changeset 0 40261b775718
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 /*
       
     2 * Copyright (c) 2006-2009 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:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 /**
       
    22  @file
       
    23  @publishedPartner 
       
    24  @released
       
    25 */
       
    26 
       
    27 
       
    28 #ifndef MAUDIOPROCESSINGUNITOBSERVER_H__
       
    29 #define MAUDIOPROCESSINGUNITOBSERVER_H__
       
    30 
       
    31 #include <e32base.h>
       
    32 
       
    33 #include <a3f/a3fbase.h>
       
    34 
       
    35 class MAudioProcessingUnit;
       
    36 
       
    37 /**
       
    38  * An interface to a set of audio processing unit callback functions.
       
    39  * 
       
    40  * this serves as the method of communication between the client and the audio processing unit.
       
    41  *
       
    42  * The class is a mixin and is intended to be inherited by the client class that is
       
    43  * interested in observing the audio processing unit operation. The functions
       
    44  * encapsulated by this class are called when specific events occur while
       
    45  * processing audio.
       
    46  * 
       
    47  * this interface is mainly usable for advanced audio clients, that are interested in detailed
       
    48  * operation of the processing chain. Most audio clients should be fine with only observing the audio stream.
       
    49  * 
       
    50  */
       
    51 class MAudioProcessingUnitObserver
       
    52 	{
       
    53 public:
       
    54 	/**
       
    55 	* Handles processing unit error event.
       
    56 	*
       
    57 	* @param aInstance A pointer to the processing unit instance.
       
    58 	* @param aError. Propagated error.
       
    59 	*/
       
    60 	virtual void ProcessingUnitError(MAudioProcessingUnit* aInstance, TInt aError)=0;
       
    61 	};
       
    62 
       
    63 #endif // MAUDIOPROCESSINGUNITOBSERVER_H__