Collapse all Symbian^3 Application Developer Library

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.

Public Member Functions
void	AddProcessingUnitComplete ( MAudioStream &, MAudioProcessingUnit *, TInt )
void	FlushComplete ( MAudioStream &, TInt )
void	ProcessingFinished ( MAudioStream &)
void	RemoveProcessingUnitComplete ( MAudioStream &, MAudioProcessingUnit *, TInt )
void	StateEvent ( MAudioStream &, TInt , TAudioState )

Member Functions Documentation

AddProcessingUnitComplete(MAudioStream &, MAudioProcessingUnit *, TInt)

void	AddProcessingUnitComplete	(	MAudioStream &	aStream,
			MAudioProcessingUnit *	aInstance,
			TInt	aError
		)	[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 & aStream	A reference to the stream to which the processing unit was added.
MAudioProcessingUnit * aInstance	a pointer to the processing unit instance.
TInt aError	an error code. KErrNone on success. Otherwise one of the system wide error codes.

FlushComplete(MAudioStream &, TInt)

void	FlushComplete	(	MAudioStream &	aStream,
			TInt	aError
		)	[pure virtual]

Signals completion of a Flush() operation.

Parameters

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

ProcessingFinished(MAudioStream &)

void

ProcessingFinished

(

MAudioStream &

aStream

)

[pure virtual]

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

Parameters

MAudioStream & aStream

A reference to the stream.

RemoveProcessingUnitComplete(MAudioStream &, MAudioProcessingUnit *, TInt)

void	RemoveProcessingUnitComplete	(	MAudioStream &	aStream,
			MAudioProcessingUnit *	aInstance,
			TInt	aError
		)	[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 & aStream	A reference to the stream from which the processing unit has been removed.
MAudioProcessingUnit * aInstance	a pointer to the processing unit instance.
TInt aError	an error code. KErrNone on success. Otherwise one of the system wide error codes.

StateEvent(MAudioStream &, TInt, TAudioState)

void	StateEvent	(	MAudioStream &	aStream,
			TInt	aReason,
			TAudioState	aNewState
		)	[pure virtual]

Handles audio stream state change event.

Parameters

MAudioStream & aStream	A reference to the stream whose state changed.
TInt aReason	A 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 aNewState	indicating the state in which the audio stream has changed.