MAudioStreamObserver Class Reference

class MAudioStreamObserver

An interface to a set of AudioStream callback functions.

this serves as the method of communication between the client and the AudioStream.

The class is a mixin and is intended to be inherited by the client class that is interested in observing the AudioStream operation. The functions encapsulated by this class are called when specific events occur while processing audio.

Member Functions Documentation

AddProcessingUnitComplete(MAudioStream &, MAudioProcessingUnit *, TInt)

voidAddProcessingUnitComplete(MAudioStream &aStream,
MAudioProcessingUnit *aInstance,
TIntaError
)[pure virtual]

Notifies that adding of processing unit to the stream has been completed successfully or otherwise.

if the processing unit is added succesfully, then it must be removed from the stream before the processing unit is removed from the context or before the stream is removed.

Parameters

MAudioStream & aStreamA reference to the stream to which the processing unit was added.
MAudioProcessingUnit * aInstancea pointer to the processing unit instance.
TInt aErroran error code. KErrNone on success. Otherwise one of the system wide error codes.

FlushComplete(MAudioStream &, TInt)

voidFlushComplete(MAudioStream &aStream,
TIntaError
)[pure virtual]

Signals completion of a Flush() operation.

Parameters

MAudioStream & aStreamA reference to the stream on which Flush() was called.
TInt aErroran error code. KErrAbort if the associated stream has been unloaded, and the buffers cease to exist.

ProcessingFinished(MAudioStream &)

voidProcessingFinished(MAudioStream &aStream)[pure virtual]

Call-back indicating that is the last buffer has been processed by the sink.

Parameters

MAudioStream & aStreamA reference to the stream.

RemoveProcessingUnitComplete(MAudioStream &, MAudioProcessingUnit *, TInt)

voidRemoveProcessingUnitComplete(MAudioStream &aStream,
MAudioProcessingUnit *aInstance,
TIntaError
)[pure virtual]

Notifies that removing of processing unit from the stream has been completed successfully or otherwise.

if the processing unit has been added succesfully, then it must be removed from the stream, before the processing unit is removed from the context or before the stream is removed.

Parameters

MAudioStream & aStreamA reference to the stream from which the processing unit has been removed.
MAudioProcessingUnit * aInstancea pointer to the processing unit instance.
TInt aErroran error code. KErrNone on success. Otherwise one of the system wide error codes.

StateEvent(MAudioStream &, TInt, TAudioState)

voidStateEvent(MAudioStream &aStream,
TIntaReason,
TAudioStateaNewState
)[pure virtual]

Handles audio stream state change event.

Parameters

MAudioStream & aStreamA reference to the stream whose state changed.
TInt aReasonA set of values describing why the state change occurred corresponding to the system-wide error codes. The value will be KErrNone on successful calls.
TAudioState aNewStateindicating the state in which the audio stream has changed.