Symbian
Symbian OS Library

SYMBIAN OS V9.3

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

Location: MdaAudioSamplePlayer.h

Class MMdaAudioPlayerCallback

class MMdaAudioPlayerCallback;

Description

An interface to a set of audio player callback functions.

The class is a mixin and is intended to be inherited by the client class which is observing the audio playing operation. The functions encapsulated by this class are called when specific events occur in the process of initialising and playing an audio sample. A reference to this object is passed as a parameter when constructing an audio player utility object.

Members

Defined in MMdaAudioPlayerCallback:
MapcInitComplete(), MapcPlayComplete()

Member functions

MapcInitComplete()

virtual void MapcInitComplete(TInt aError, const TTimeIntervalMicroSeconds &aDuration)=0;

Description

Defines required client behaviour when an attempt to open and initialise an audio sample has completed, successfully or otherwise.

Parameters

TInt aError

The status of the audio sample after initialisation. The following values have the same specific meaning across all EPOC platforms: KErrNone the sample is ready to play. KErrNotSupported the audio format or particular encoding type is not recognised or not supported. KErrNotFound the audio sample cannot be found. KErrNoMemory there is insufficient memory to play this audio sample. Other values are possible indicating a problem opening the audio sample. These values are dependent on the EPOC platform.

const TTimeIntervalMicroSeconds &aDuration

The duration of the audio sample.

MapcPlayComplete()

virtual void MapcPlayComplete(TInt aError)=0;

Description

Defines required client behaviour when an attempt to playback an audio sample has completed, successfully or otherwise.

Parameters

TInt aError

The status of playback. The following values have the same specific meaning across all EPOC platforms: KErrNone playing of the audio sample is complete. KErrCorrupt the sample data is corrupt. KErrInUse the sound device is in use by another higher priority client. This can happen during playback. KErrNoMemory there is insufficient memory to play this audio sample Other values are possible indicating a problem opening the audio sample. These values are dependent on the EPOC platform.

[Previous] [Top] [Next]