Class MVideoPlayerUtilityObserver

class MVideoPlayerUtilityObserver;

Description

An interface to a set of video player callback functions.

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

Members

Defined in MVideoPlayerUtilityObserver:
MvpuoEvent(), MvpuoFrameReady(), MvpuoOpenComplete(), MvpuoPlayComplete(), MvpuoPrepareComplete()

virtual void MvpuoOpenComplete(TInt aError)=0;

Description

Notification to the client that the opening of the video clip has completed, successfully, or otherwise.

The status of the video sample after opening is given by aError. The following values have the same meaning across all devices:

• KErrNone: the sample is ready to play;

• KErrNotSupported: the controller plugin is not recognised or not supported;

• KErrNotFound: the video sample cannot be found;

• KErrNoMemory: there is insufficient memory to play this video sample.

Other values are possible indicating a problem opening the video sample. These values are device dependent.

The client must now call Prepare() on the video player utility before the video clip can be played or any of its properties (e.g. duration) can be queried.

Parameters

TInt aError The status of the video player after initialisation.

virtual void MvpuoPrepareComplete(TInt aError)=0;

Description

Notification to the client that the opening of the video clip has been prepared successfully, or otherwise. This callback is called in response to a call to CVideoPlayerUtility::Prepare().

The video clip may now be played, or have any of its properties (e.g. duration) queried.

Parameters

TInt aError The status of the video player after initialisation. This is either KErrNone if the open has completed successfully, or one of the system wide error codes.

virtual void MvpuoFrameReady(CFbsBitmap &aFrame, TInt aError)=0;

Description

Notification that the frame requested by a call to GetFrameL is ready

Parameters

CFbsBitmap &aFrame The returned frame. The bitmap will contain the requested frame if the the error code is KErrNone (success). TInt aError The status of the frame request. This is either KErrNone if the frame request was successful, or one of the system wide error codes.

virtual void MvpuoPlayComplete(TInt aError)=0;

Description

Notification that video playback has completed. This is not called if playback is explicitly stopped by calling Stop.

Parameters

TInt aError The status of playback. This is either KErrNone if the playback was completed successfully, or one of the system wide error codes.

virtual void MvpuoEvent(const TMMFEvent &aEvent)=0;

Description

General event notification from controller. These events are specified by the supplier of the controller

Parameters

const TMMFEvent &aEvent The event sent by the controller.