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