| class MAudioContext |
An interface to an audio context.
Audio context is a container for a set of logically related audio streams and audio processing units. All streams and processing units are created into a context. A new context can be created using an instance of CAudioContextFactory. When the context is no longer needed, it must be removed using CAudioContextFactory::DeleteAudioContext().
| Public Member Functions | |
|---|---|
| TInt | Commit() |
| TAudioContextId | ContextId() |
| TInt | CreateAudioProcessingUnit(TUid, MAudioProcessingUnit *&) |
| TInt | CreateAudioStream(MAudioStream *&) |
| void | DeleteAudioProcessingUnit(MAudioProcessingUnit *&) |
| void | DeleteAudioStream(MAudioStream *&) |
| TAny * | Interface(TUid) |
| TInt | RegisterAudioContextObserver(MAudioContextObserver &) |
| TInt | Reset() |
| TInt | SetClientSettings(const TClientContextSettings &) |
| void | UnregisterAudioContextObserver(MAudioContextObserver &) |
| TInt | Commit | ( | ) | [pure virtual] |
Apply changes made to audio components associated with this context.
A state change applied to an Audio Stream should be considered "pending" until Commit() is called, in that the adaptation merely records that the state setting has been requested and does not seek to implement the state change until Commit().
Commit() can be thought of as an asynchronous call, and completion is signalled by the appropriate ContextEvent() callback of MAudioContextObserver.
| TInt | CreateAudioProcessingUnit | ( | TUid | aTypeId, |
| MAudioProcessingUnit *& | aProcessingUnit | |||
| ) | [pure virtual] | |||
Creates a new audio processing unit into this context.
The processing unit must be removed using DeleteProcessingUnit() when it is no longer needed.
| TUid aTypeId | |
| MAudioProcessingUnit *& aProcessingUnit | on return contains a pointer to the created processing unit. |
| TInt | CreateAudioStream | ( | MAudioStream *& | aStream | ) | [pure virtual] |
Creates a new audio stream into this context.
The stream must be removed using DeleteAudioStream() when it is no longer needed.
| MAudioStream *& aStream | on return contains a pointer to the created stream. |
| void | DeleteAudioProcessingUnit | ( | MAudioProcessingUnit *& | aProcessingUnit | ) | [pure virtual] |
Deletes the audio processing unit from this context.
After removing the processing unit all references to it will become invalid and must not be used. At the end of the call, aProcessingUnit will have been set to NULL. Calling DeleteAudioProcessingUnit() with a parameter whose value is NULL is itself a null operation.
| MAudioProcessingUnit *& aProcessingUnit | a pointer to the processing unit to remove. |
| void | DeleteAudioStream | ( | MAudioStream *& | aStream | ) | [pure virtual] |
Deletes an audio stream from this context.
After removing the stream all references to it will become invalid and must not be used. At the end of the call, aStream will have been set to NULL. Calling DeleteAudioStream() with a parameter whose value is NULL is itself a null operation.
| MAudioStream *& aStream | a pointer to the stream to Delete. |
| TAny * | Interface | ( | TUid | aType | ) | [pure virtual] |
A mechanism to obtain extensions to the Context API.
| TUid aType | Uid that denotes the type of the interface. |
| TInt | RegisterAudioContextObserver | ( | MAudioContextObserver & | aObserver | ) | [pure virtual] |
Registers an audio context observer.
The observer will be notified about context state changes.
| MAudioContextObserver & aObserver | the observer reference to register. |
| TInt | Reset | ( | ) | [pure virtual] |
Forget any pending, requested changes made to this context or its components.
Typically called where the client has started to request changes, has yet to call Commit() and changes its mind.
| TInt | SetClientSettings | ( | const TClientContextSettings & | aSettings | ) | [pure virtual] |
Sets the client information used by the underlying MMRC.
This must be called before any call to Commit(). The client context contains information about the client application which is utilising the audio functionality, since this will typically be a different process than is calling A3F.
| const TClientContextSettings & aSettings | Essentially the process Id of the client application, the one whose details are used to determine capabilities and policy. |
| void | UnregisterAudioContextObserver | ( | MAudioContextObserver & | aObserver | ) | [pure virtual] |
Unregisters an audio context observer.
| MAudioContextObserver & aObserver | the observer reference to unregister. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.