|
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 MAUDIOCONTEXT_H
|
|
sl@0
|
29 |
#define MAUDIOCONTEXT_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 MAudioStream;
|
|
sl@0
|
36 |
class MAudioProcessingUnit;
|
|
sl@0
|
37 |
class MAudioContextObserver;
|
|
sl@0
|
38 |
|
|
sl@0
|
39 |
/**
|
|
sl@0
|
40 |
* An interface to an audio context.
|
|
sl@0
|
41 |
*
|
|
sl@0
|
42 |
* Audio context is a container for a set of logically related audio streams and audio processing units.
|
|
sl@0
|
43 |
* All streams and processing units are created into a context.
|
|
sl@0
|
44 |
* A new context can be created using an instance of CAudioContextFactory.
|
|
sl@0
|
45 |
* When the context is no longer needed, it must be removed using CAudioContextFactory::DeleteAudioContext().
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
class MAudioContext
|
|
sl@0
|
48 |
{
|
|
sl@0
|
49 |
public:
|
|
sl@0
|
50 |
|
|
sl@0
|
51 |
/**
|
|
sl@0
|
52 |
* Returns the context identifier.
|
|
sl@0
|
53 |
*
|
|
sl@0
|
54 |
* @return return the context identifier
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
virtual TAudioContextId ContextId() const = 0;
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Creates a new audio stream into this context.
|
|
sl@0
|
60 |
*
|
|
sl@0
|
61 |
* The stream must be removed using DeleteAudioStream() when it is no longer needed.
|
|
sl@0
|
62 |
*
|
|
sl@0
|
63 |
* @param aStream on return contains a pointer to the created stream.
|
|
sl@0
|
64 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
65 |
*/
|
|
sl@0
|
66 |
virtual TInt CreateAudioStream(MAudioStream*& aStream)=0;
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
/**
|
|
sl@0
|
69 |
* Deletes an audio stream from this context.
|
|
sl@0
|
70 |
*
|
|
sl@0
|
71 |
* After removing the stream all references to it will become invalid and must not be used.
|
|
sl@0
|
72 |
* At the end of the call, aStream will have been set to NULL.
|
|
sl@0
|
73 |
* Calling DeleteAudioStream() with a parameter whose value is NULL is itself a null operation.
|
|
sl@0
|
74 |
* @param aStream a pointer to the stream to Delete.
|
|
sl@0
|
75 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
76 |
*/
|
|
sl@0
|
77 |
virtual void DeleteAudioStream(MAudioStream*& aStream)=0;
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
/**
|
|
sl@0
|
80 |
* Creates a new audio processing unit into this context.
|
|
sl@0
|
81 |
*
|
|
sl@0
|
82 |
* The processing unit must be removed using DeleteProcessingUnit() when it is no longer needed.
|
|
sl@0
|
83 |
*
|
|
sl@0
|
84 |
* @param aType the type of the processing unit.
|
|
sl@0
|
85 |
* @param aProcessingUnit on return contains a pointer to the created processing unit.
|
|
sl@0
|
86 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
87 |
*/
|
|
sl@0
|
88 |
virtual TInt CreateAudioProcessingUnit(TUid aTypeId, MAudioProcessingUnit*& aProcessingUnit)=0;
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
/**
|
|
sl@0
|
91 |
* Deletes the audio processing unit from this context.
|
|
sl@0
|
92 |
*
|
|
sl@0
|
93 |
* After removing the processing unit all references to it will become invalid and must not be used.
|
|
sl@0
|
94 |
* At the end of the call, aProcessingUnit will have been set to NULL.
|
|
sl@0
|
95 |
* Calling DeleteAudioProcessingUnit() with a parameter whose value is NULL is itself a null operation.
|
|
sl@0
|
96 |
* @param aProcessingUnit a pointer to the processing unit to remove.
|
|
sl@0
|
97 |
* @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
98 |
*/
|
|
sl@0
|
99 |
virtual void DeleteAudioProcessingUnit(MAudioProcessingUnit*& aProcessingUnit)=0;
|
|
sl@0
|
100 |
|
|
sl@0
|
101 |
/**
|
|
sl@0
|
102 |
* Apply changes made to audio components associated with this context.
|
|
sl@0
|
103 |
*
|
|
sl@0
|
104 |
* A state change applied to an Audio Stream should be considered "pending" until Commit() is called,
|
|
sl@0
|
105 |
* in that the adaptation merely records that the state setting has been requested and does not seek
|
|
sl@0
|
106 |
* to implement the state change until Commit().
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* Commit() can be thought of as an asynchronous call, and completion is signalled by the appropriate
|
|
sl@0
|
109 |
* ContextEvent() callback of MAudioContextObserver.
|
|
sl@0
|
110 |
* @return An error code. KErrNone on success. KErrNotReady if SetClientSettings() has not been called.
|
|
sl@0
|
111 |
*/
|
|
sl@0
|
112 |
virtual TInt Commit()=0;
|
|
sl@0
|
113 |
|
|
sl@0
|
114 |
/**
|
|
sl@0
|
115 |
* Forget any pending, requested changes made to this context or its components.
|
|
sl@0
|
116 |
*
|
|
sl@0
|
117 |
* Typically called where the client has started to request changes, has yet to call Commit() and changes its mind.
|
|
sl@0
|
118 |
*
|
|
sl@0
|
119 |
* @return A system wide error code. KErrNone on success. KErrNotReady if called during Commit() cycle.
|
|
sl@0
|
120 |
*/
|
|
sl@0
|
121 |
virtual TInt Reset()=0;
|
|
sl@0
|
122 |
|
|
sl@0
|
123 |
/**
|
|
sl@0
|
124 |
* Sets the client information used by the underlying MMRC.
|
|
sl@0
|
125 |
*
|
|
sl@0
|
126 |
* This must be called before any call to Commit(). The client context contains information about the client application
|
|
sl@0
|
127 |
* which is utilising the audio functionality, since this will typically be a different process than is calling A3F.
|
|
sl@0
|
128 |
*
|
|
sl@0
|
129 |
* @param aSettings Essentially the process Id of the client application,
|
|
sl@0
|
130 |
* the one whose details are used to determine capabilities and policy.
|
|
sl@0
|
131 |
* @return an error code. KErrNone for success, otherwise one of the system-wide error codes.
|
|
sl@0
|
132 |
*/
|
|
sl@0
|
133 |
virtual TInt SetClientSettings(const TClientContextSettings& aSettings)=0;
|
|
sl@0
|
134 |
|
|
sl@0
|
135 |
/**
|
|
sl@0
|
136 |
* A mechanism to obtain extensions to the Context API.
|
|
sl@0
|
137 |
*
|
|
sl@0
|
138 |
* @param aType Uid that denotes the type of the interface.
|
|
sl@0
|
139 |
* @return the pointer to the specified interface, or NULL if it does not exist.
|
|
sl@0
|
140 |
* Must be cast to correct type by the user.
|
|
sl@0
|
141 |
*/
|
|
sl@0
|
142 |
virtual TAny* Interface(TUid aType)=0;
|
|
sl@0
|
143 |
|
|
sl@0
|
144 |
/**
|
|
sl@0
|
145 |
* Registers an audio context observer.
|
|
sl@0
|
146 |
*
|
|
sl@0
|
147 |
* The observer will be notified about context state changes.
|
|
sl@0
|
148 |
*
|
|
sl@0
|
149 |
* @param aObserver the observer reference to register.
|
|
sl@0
|
150 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
151 |
*/
|
|
sl@0
|
152 |
virtual TInt RegisterAudioContextObserver(MAudioContextObserver& aObserver) = 0;
|
|
sl@0
|
153 |
|
|
sl@0
|
154 |
/**
|
|
sl@0
|
155 |
* Unregisters an audio context observer.
|
|
sl@0
|
156 |
*
|
|
sl@0
|
157 |
* @param aObserver the observer reference to unregister.
|
|
sl@0
|
158 |
* @return An error code. KErrNone on success, otherwise one of the system wide error codes.
|
|
sl@0
|
159 |
*/
|
|
sl@0
|
160 |
virtual void UnregisterAudioContextObserver(MAudioContextObserver& aObserver) = 0;
|
|
sl@0
|
161 |
};
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
#endif // MAUDIOCONTEXT_H
|