os/mm/devsound/a3facf/inc/maudioprocessingunitobserver.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsound/a3facf/inc/maudioprocessingunitobserver.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,63 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2009 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:
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +
    1.24 +/**
    1.25 + @file
    1.26 + @publishedPartner 
    1.27 + @released
    1.28 +*/
    1.29 +
    1.30 +
    1.31 +#ifndef MAUDIOPROCESSINGUNITOBSERVER_H__
    1.32 +#define MAUDIOPROCESSINGUNITOBSERVER_H__
    1.33 +
    1.34 +#include <e32base.h>
    1.35 +
    1.36 +#include <a3f/a3fbase.h>
    1.37 +
    1.38 +class MAudioProcessingUnit;
    1.39 +
    1.40 +/**
    1.41 + * An interface to a set of audio processing unit callback functions.
    1.42 + * 
    1.43 + * this serves as the method of communication between the client and the audio processing unit.
    1.44 + *
    1.45 + * The class is a mixin and is intended to be inherited by the client class that is
    1.46 + * interested in observing the audio processing unit operation. The functions
    1.47 + * encapsulated by this class are called when specific events occur while
    1.48 + * processing audio.
    1.49 + * 
    1.50 + * this interface is mainly usable for advanced audio clients, that are interested in detailed
    1.51 + * operation of the processing chain. Most audio clients should be fine with only observing the audio stream.
    1.52 + * 
    1.53 + */
    1.54 +class MAudioProcessingUnitObserver
    1.55 +	{
    1.56 +public:
    1.57 +	/**
    1.58 +	* Handles processing unit error event.
    1.59 +	*
    1.60 +	* @param aInstance A pointer to the processing unit instance.
    1.61 +	* @param aError. Propagated error.
    1.62 +	*/
    1.63 +	virtual void ProcessingUnitError(MAudioProcessingUnit* aInstance, TInt aError)=0;
    1.64 +	};
    1.65 +
    1.66 +#endif // MAUDIOPROCESSINGUNITOBSERVER_H__