Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MdaAudioOutputStream.h

Class MMdaAudioOutputStreamCallback

class MMdaAudioOutputStreamCallback;

Description

An interface class that notifies the client of the progress of audio output streaming.

It must be implemented by users of the CMdaAudioOutputStream class.

An object that implements this interface is passed to CMdaAudioOutputStream::NewL().

Members

Defined in MMdaAudioOutputStreamCallback:
MaoscBufferCopied(), MaoscOpenComplete(), MaoscPlayComplete()


Member functions


MaoscOpenComplete()

virtual void MaoscOpenComplete(TInt aError)=0;

Description

A callback function that is called when CMdaAudioOutputStream::Open() has completed, indicating that the audio output stream is ready for use.

Parameters

TInt aError

An error value which indicates if open was completed successfully. KErrNone if succeeded.


MaoscBufferCopied()

virtual void MaoscBufferCopied(TInt aError, const TDesC8 &aBuffer)=0;

Description

A callback function that is called when a descriptor has been copied to the lower layers of MMF.

It is also called when an error has occurred or when the client has stopped the stream playing before the descriptor has been fully copied (by calling CMdaAudioOutputStream::Stop()).

This function indicates to the client that it is safe to destroy the buffer passed to CMdaAudioOutputStream::WriteL(). It can also be used to make the next call to WriteL().

Parameters

TInt aError

KErrNone if the copy succeeded, otherwise one of the system error codes. KErrAbort indicates that the client has stopped the stream playing before the descriptor has been copied.

const TDesC8 &aBuffer

A reference to the buffer that has been copied.


MaoscPlayComplete()

virtual void MaoscPlayComplete(TInt aError)=0;

Description

A callback function that is called when playback terminates as a result of a CMdaAudioOutputStream::Stop().

If the end of the sound data has been reached, the function returns KErrUnderFlow. If playback terminates for any other reason, the function returns an appropriate error value.

Parameters

TInt aError

An error value which indicates play success or not. KErrNone if the close succeeded, otherwise one of the system error codes.