|
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 MAUDIOSTREAMOBSERVER_H
|
|
sl@0
|
29 |
#define MAUDIOSTREAMOBSERVER_H
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
#include <e32base.h>
|
|
sl@0
|
32 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
33 |
#include <a3f/maudiostream.h>
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
* An interface to a set of AudioStream callback functions.
|
|
sl@0
|
37 |
*
|
|
sl@0
|
38 |
* this serves as the method of communication between the client and the
|
|
sl@0
|
39 |
* AudioStream.
|
|
sl@0
|
40 |
*
|
|
sl@0
|
41 |
* The class is a mixin and is intended to be inherited by the client class
|
|
sl@0
|
42 |
* that is interested in observing the AudioStream operation. The functions
|
|
sl@0
|
43 |
* encapsulated by this class are called when specific events occur while
|
|
sl@0
|
44 |
* processing audio.
|
|
sl@0
|
45 |
*/
|
|
sl@0
|
46 |
class MAudioStreamObserver
|
|
sl@0
|
47 |
{
|
|
sl@0
|
48 |
public:
|
|
sl@0
|
49 |
/**
|
|
sl@0
|
50 |
* Handles audio stream state change event.
|
|
sl@0
|
51 |
*
|
|
sl@0
|
52 |
* @param aStream A reference to the stream whose state changed.
|
|
sl@0
|
53 |
* @param aReason A set of values describing why the state change occurred
|
|
sl@0
|
54 |
* corresponding to the system-wide error codes. The value will be KErrNone on successful calls.
|
|
sl@0
|
55 |
* @param aNewState indicating the state in which the audio stream has changed.
|
|
sl@0
|
56 |
*/
|
|
sl@0
|
57 |
virtual void StateEvent(MAudioStream& aStream , TInt aReason, TAudioState aNewState)=0;
|
|
sl@0
|
58 |
|
|
sl@0
|
59 |
/**
|
|
sl@0
|
60 |
* Notifies that adding of processing unit to the stream has been completed successfully or otherwise.
|
|
sl@0
|
61 |
*
|
|
sl@0
|
62 |
* if the processing unit is added succesfully, then it must be removed from the
|
|
sl@0
|
63 |
* stream before the processing unit is removed from the context or before the stream is removed.
|
|
sl@0
|
64 |
*
|
|
sl@0
|
65 |
* @param aStream A reference to the stream to which the processing unit was added.
|
|
sl@0
|
66 |
* @param aInstance a pointer to the processing unit instance.
|
|
sl@0
|
67 |
* @param aError an error code. KErrNone on success. Otherwise one of the system wide error codes.
|
|
sl@0
|
68 |
*/
|
|
sl@0
|
69 |
virtual void AddProcessingUnitComplete(MAudioStream& aStream, MAudioProcessingUnit* aInstance, TInt aError)=0;
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
* Notifies that removing of processing unit from the stream has been completed
|
|
sl@0
|
73 |
* successfully or otherwise.
|
|
sl@0
|
74 |
*
|
|
sl@0
|
75 |
* if the processing unit has been added succesfully, then it must be removed
|
|
sl@0
|
76 |
* from the stream, before the processing unit is removed from the
|
|
sl@0
|
77 |
* context or before the stream is removed.
|
|
sl@0
|
78 |
*
|
|
sl@0
|
79 |
* @param aStream A reference to the stream from which the processing unit has been removed.
|
|
sl@0
|
80 |
* @param aType the processing unit type.
|
|
sl@0
|
81 |
* @param aInstance a pointer to the processing unit instance.
|
|
sl@0
|
82 |
* @param aError an error code. KErrNone on success. Otherwise one of the system wide error codes.
|
|
sl@0
|
83 |
*/
|
|
sl@0
|
84 |
virtual void RemoveProcessingUnitComplete(MAudioStream& aStream, MAudioProcessingUnit* aInstance, TInt aError)=0;
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
/**
|
|
sl@0
|
87 |
* Call-back indicating that is the last buffer has been processed by the sink.
|
|
sl@0
|
88 |
*
|
|
sl@0
|
89 |
* @param aStream A reference to the stream.
|
|
sl@0
|
90 |
*/
|
|
sl@0
|
91 |
virtual void ProcessingFinished (MAudioStream& aStream)=0;
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
/**
|
|
sl@0
|
94 |
* Signals completion of a Flush() operation.
|
|
sl@0
|
95 |
*
|
|
sl@0
|
96 |
* @param aStream A reference to the stream on which Flush() was called.
|
|
sl@0
|
97 |
* @param aError an error code. KErrAbort if the associated stream has been unloaded, and the buffers cease to exist.
|
|
sl@0
|
98 |
*/
|
|
sl@0
|
99 |
virtual void FlushComplete (MAudioStream& aStream, TInt aError) = 0;
|
|
sl@0
|
100 |
|
|
sl@0
|
101 |
};
|
|
sl@0
|
102 |
|
|
sl@0
|
103 |
#endif // MAUDIOSTREAMOBSERVER_H
|