|
sl@0
|
1 |
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@file
|
|
sl@0
|
20 |
@publishedPartner
|
|
sl@0
|
21 |
@released
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#ifndef MAUDIOPROCESSINGUNIT_H
|
|
sl@0
|
26 |
#define MAUDIOPROCESSINGUNIT_H
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#include <e32base.h>
|
|
sl@0
|
29 |
#include <f32file.h>
|
|
sl@0
|
30 |
#include <mmf/common/mmfcontroller.h>
|
|
sl@0
|
31 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
class MAudioProcessingUnitObserver;
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
/**
|
|
sl@0
|
36 |
* A generic interface for audio processing units.
|
|
sl@0
|
37 |
*/
|
|
sl@0
|
38 |
class MAudioProcessingUnit
|
|
sl@0
|
39 |
{
|
|
sl@0
|
40 |
public:
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
/**
|
|
sl@0
|
43 |
* Fetches the identifier of the context in which this processing unit exists.
|
|
sl@0
|
44 |
*
|
|
sl@0
|
45 |
* @return TUid context instance id.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
virtual TAudioContextId ContextId() const = 0;
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
/**
|
|
sl@0
|
51 |
* Fetches the specified interface to this processing unit.
|
|
sl@0
|
52 |
* The interface must not be deleted by the client.
|
|
sl@0
|
53 |
* The processing unit must be removed once from the context using
|
|
sl@0
|
54 |
* any of the retrieved processing unit interfaces.
|
|
sl@0
|
55 |
* @param aTypeId the type of the interface
|
|
sl@0
|
56 |
*/
|
|
sl@0
|
57 |
virtual TAny* Interface(TUid aType)=0;
|
|
sl@0
|
58 |
|
|
sl@0
|
59 |
/**
|
|
sl@0
|
60 |
* Registers a processing unit observer.
|
|
sl@0
|
61 |
*
|
|
sl@0
|
62 |
* The observer must be unregistered before the processing unit is removed from the context.
|
|
sl@0
|
63 |
*
|
|
sl@0
|
64 |
* @see MAudioProcessingUnitObserver for further inforamtion about the observer usage.
|
|
sl@0
|
65 |
* @param aObserver a reference to the observer to register
|
|
sl@0
|
66 |
* @return an error code. KErrNone if successful.
|
|
sl@0
|
67 |
* KErrNotSupported the processing unit does not provide support for this type of observation.
|
|
sl@0
|
68 |
* Other system wide error codes are also possible.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
virtual TInt RegisterProcessingUnitObserver(MAudioProcessingUnitObserver& aObserver)=0;
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
* Unregisters audio processing unit observer.
|
|
sl@0
|
74 |
*
|
|
sl@0
|
75 |
* @see RegisterProcessingUnitObserver for further information.
|
|
sl@0
|
76 |
* @param aObserver a reference to the processing unit observer to unregister.
|
|
sl@0
|
77 |
* @return an error code. KErrNone if successful.
|
|
sl@0
|
78 |
*/
|
|
sl@0
|
79 |
virtual void UnregisterProcessingUnitObserver(MAudioProcessingUnitObserver& aObserver)=0;
|
|
sl@0
|
80 |
|
|
sl@0
|
81 |
/**
|
|
sl@0
|
82 |
* Returns the component instance id.
|
|
sl@0
|
83 |
*
|
|
sl@0
|
84 |
* @return TUid component instance id.
|
|
sl@0
|
85 |
*/
|
|
sl@0
|
86 |
virtual TAudioComponentId InstanceId() const = 0;
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
* Returns if the component is the same type of the given feature Uid.
|
|
sl@0
|
90 |
* @param aTypeId a feature Uid to compare with.
|
|
sl@0
|
91 |
*/
|
|
sl@0
|
92 |
virtual TBool IsTypeOf(TUid aTypeId) const = 0;
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
};
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
#endif // MAUDIOPROCESSINGUNIT_H
|