Class MMMFVideoPlayControllerCustomCommandImplementor

class MMMFVideoPlayControllerCustomCommandImplementor;

Description

Client class to access functionality specific to a video playback controller.

The class uses the custom command function of the controller plugin, and removes the necessity for the client to formulate the custom commands.

Members

Defined in MMMFVideoPlayControllerCustomCommandImplementor:
MvpcDirectScreenAccessEventL(), MvpcGetAudioEnabledL(), MvpcGetCropRegionL(), MvpcGetFrameL(), MvpcGetLoadingProgressL(), MvpcGetRotationL(), MvpcGetScaleFactorL(), MvpcPlayL(), MvpcPrepare(), MvpcRefreshFrameL(), MvpcSetCropRegionL(), MvpcSetDisplayWindowL(), MvpcSetRotationL(), MvpcSetScaleFactorL(), MvpcUpdateDisplayRegionL()

virtual void MvpcPrepare()=0;

Description

Prepares the video clip to be accessed.

A call to this method tells the controller plugin to finalise its configuration and to prepare to start reading the video clip. It is not possible to play the video clip or query any of its properties (e.g. duration, meta data etc.) until the controller plugin has signified the completion of this method by generating a KMMFEventCategoryVideoPrepareComplete event.

virtual void MvpcGetFrameL(MMMFVideoFrameMessage &aVideoFrame)=0;

Description

Gets a frame previously requested from the controller.

Parameters

MMMFVideoFrameMessage &aVideoFrame The handle of bitmap to retrieve frame to.

virtual void MvpcGetAudioEnabledL(TBool &aEnabled)=0;

Description

Indicates whether audio is enabled.

Parameters

TBool &aEnabled On return, contains a boolean indicating whether audio is enabled.

virtual void MvpcSetDisplayWindowL(const TRect &aWindowRect, const TRect &aClipRect)=0;

Description

Sets the screen region to be used to display the video.

Parameters

const TRect &aWindowRect const TRect &aClipRect The clip rect used to display the video.

virtual void MvpcUpdateDisplayRegionL(const TRegion &aRegion)=0;

Description

Updates the region to display.

Parameters

const TRegion &aRegion A TRegion containing the current display regions, ownership of the TRegion is not transferred.

virtual void MvpcDirectScreenAccessEventL(const TMMFDSAEvent aDSAEvent)=0;

Description

Pauses/Resumes video playback. This is to be used with direct screen access to indicate that the display has changed and should not be written to. This does not affect audio playback.

Parameters

const TMMFDSAEvent aDSAEvent Whether the video display should be active.

virtual void MvpcPlayL(const TTimeIntervalMicroSeconds &aStart, const TTimeIntervalMicroSeconds &aEnd)=0;

Description

Sets a time window for video playback.

Parameters

const TTimeIntervalMicroSeconds &aStart Start time in milliseconds relative to the start of the video clip. const TTimeIntervalMicroSeconds &aEnd End time in milliseconds relative to the start of the video clip.

virtual void MvpcRefreshFrameL()=0;

Description

Requests the controller to redraw the current frame.

virtual void MvpcGetLoadingProgressL(TInt &aPercentageComplete)=0;

Description

Gets the progress of loading a video clip.

Parameters

TInt &aPercentageComplete The progress loading the clip, as a percentage.

virtual void MvpcSetRotationL(TVideoRotation aRotation)=0;

Description

Rotates the video image on the screen.

Parameters

TVideoRotation aRotation The desired rotation to apply.

virtual void MvpcGetRotationL(TVideoRotation &aRotation)=0;

Description

Queries the rotation that is currently applied to the video image.

Parameters

TVideoRotation &aRotation The applied rotation.

virtual void MvpcSetScaleFactorL(TReal32 aWidthPercentage, TReal32 aHeightPercentage, TBool aAntiAliasFiltering)=0;

Description

Scales the video image to a specified percentage of its original size.

Parameters

TReal32 aWidthPercentage The percentage (100 = original size) to be used to scale the width of the video image. TReal32 aHeightPercentage The percentage (100 = original size) to be used to scale the height of the video image. If this is not equal to aWidthPercentage then the image may be distorted. TBool aAntiAliasFiltering A boolean indicating if anit-aliasing filtering should be used. ETrue if anti-aliasing should be used. If the plugin does not support this kind of processing, this value will be ignored.

virtual void MvpcGetScaleFactorL(TReal32 &aWidthPercentage, TReal32 &aHeightPercentage, TBool &aAntiAliasFiltering)=0;

Description

Gets the scale factor currently applied to the video image.

Parameters

TReal32 &aWidthPercentage The percentage (100 = original size) used to scale the width of the video image will be copied into here. TReal32 &aHeightPercentage The percentage (100 = original size) used to scale the height of the video image will be copied into here. TBool &aAntiAliasFiltering A boolean indicating if anti-aliasing filtering should be used. ETrue if anti-aliasing filtering is being used, EFalse if not.

virtual void MvpcSetCropRegionL(const TRect &aCropRegion)=0;

Description

Selects a region of the video image to be displayed.

Parameters

const TRect &aCropRegion The dimensions of the crop region, relative to the video image.

virtual void MvpcGetCropRegionL(TRect &aCropRegion)=0;

Description

Gets the crop region currently applied to the image

Parameters

TRect &aCropRegion The dimensions of the crop region, relative to the video image. If no crop region has been applied, the full dimensions of the video image will be returned.