os/mm/devsound/a3facf/inc/maudioprocessingunitobserver.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description:
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
sl@0
    20
sl@0
    21
/**
sl@0
    22
 @file
sl@0
    23
 @publishedPartner 
sl@0
    24
 @released
sl@0
    25
*/
sl@0
    26
sl@0
    27
sl@0
    28
#ifndef MAUDIOPROCESSINGUNITOBSERVER_H__
sl@0
    29
#define MAUDIOPROCESSINGUNITOBSERVER_H__
sl@0
    30
sl@0
    31
#include <e32base.h>
sl@0
    32
sl@0
    33
#include <a3f/a3fbase.h>
sl@0
    34
sl@0
    35
class MAudioProcessingUnit;
sl@0
    36
sl@0
    37
/**
sl@0
    38
 * An interface to a set of audio processing unit callback functions.
sl@0
    39
 * 
sl@0
    40
 * this serves as the method of communication between the client and the audio processing unit.
sl@0
    41
 *
sl@0
    42
 * The class is a mixin and is intended to be inherited by the client class that is
sl@0
    43
 * interested in observing the audio processing unit operation. The functions
sl@0
    44
 * encapsulated by this class are called when specific events occur while
sl@0
    45
 * processing audio.
sl@0
    46
 * 
sl@0
    47
 * this interface is mainly usable for advanced audio clients, that are interested in detailed
sl@0
    48
 * operation of the processing chain. Most audio clients should be fine with only observing the audio stream.
sl@0
    49
 * 
sl@0
    50
 */
sl@0
    51
class MAudioProcessingUnitObserver
sl@0
    52
	{
sl@0
    53
public:
sl@0
    54
	/**
sl@0
    55
	* Handles processing unit error event.
sl@0
    56
	*
sl@0
    57
	* @param aInstance A pointer to the processing unit instance.
sl@0
    58
	* @param aError. Propagated error.
sl@0
    59
	*/
sl@0
    60
	virtual void ProcessingUnitError(MAudioProcessingUnit* aInstance, TInt aError)=0;
sl@0
    61
	};
sl@0
    62
sl@0
    63
#endif // MAUDIOPROCESSINGUNITOBSERVER_H__