MMMFVideoPlayControllerCustomCommandImplementor Class Reference

class MMMFVideoPlayControllerCustomCommandImplementor

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.

7.0s

Member Functions Documentation

MvpcDirectScreenAccessEventL(const TMMFDSAEvent)

voidMvpcDirectScreenAccessEventL(const TMMFDSAEventaDSAEvent)[pure virtual]

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.

7.0s

Parameters

const TMMFDSAEvent aDSAEventWhether the video display should be active.

MvpcGetAudioEnabledL(TBool &)

voidMvpcGetAudioEnabledL(TBool &aEnabled)[pure virtual]

Indicates whether audio is enabled.

7.0s

Parameters

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

MvpcGetCropRegionL(TRect &)

voidMvpcGetCropRegionL(TRect &aCropRegion)[pure virtual]

Gets the crop region currently applied to the image

7.0s

Parameters

TRect & aCropRegionThe 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.

MvpcGetFrameL(MMMFVideoFrameMessage &)

voidMvpcGetFrameL(MMMFVideoFrameMessage &aVideoFrame)[pure virtual]

Gets a frame previously requested from the controller.

7.0s

Parameters

MMMFVideoFrameMessage & aVideoFrameThe handle of bitmap to retrieve frame to.

MvpcGetLoadingProgressL(TInt &)

voidMvpcGetLoadingProgressL(TInt &aPercentageComplete)[pure virtual]

Gets the progress of loading a video clip.

7.0s

Parameters

TInt & aPercentageCompleteThe progress loading the clip, as a percentage.

MvpcGetRotationL(TVideoRotation &)

voidMvpcGetRotationL(TVideoRotation &aRotation)[pure virtual]

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

7.0s

Parameters

TVideoRotation & aRotationThe applied rotation.

MvpcGetScaleFactorL(TReal32 &, TReal32 &, TBool &)

voidMvpcGetScaleFactorL(TReal32 &aWidthPercentage,
TReal32 &aHeightPercentage,
TBool &aAntiAliasFiltering
)[pure virtual]

Gets the scale factor currently applied to the video image.

7.0s

Parameters

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

MvpcPlayL(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

voidMvpcPlayL(const TTimeIntervalMicroSeconds &aStart,
const TTimeIntervalMicroSeconds &aEnd
)[pure virtual]

Sets a time window for video playback.

7.0s

Parameters

const TTimeIntervalMicroSeconds & aStartStart time in milliseconds relative to the start of the video clip.
const TTimeIntervalMicroSeconds & aEndEnd time in milliseconds relative to the start of the video clip.

MvpcPrepare()

voidMvpcPrepare()[pure virtual]

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.

7.0s

MvpcRefreshFrameL()

voidMvpcRefreshFrameL()[pure virtual]

Requests the controller to redraw the current frame.

7.0s

MvpcSetCropRegionL(const TRect &)

voidMvpcSetCropRegionL(const TRect &aCropRegion)[pure virtual]

Selects a region of the video image to be displayed.

7.0s

Parameters

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

MvpcSetDisplayWindowL(const TRect &, const TRect &)

voidMvpcSetDisplayWindowL(const TRect &aWindowRect,
const TRect &aClipRect
)[pure virtual]

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

7.0s

Parameters

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

MvpcSetRotationL(TVideoRotation)

voidMvpcSetRotationL(TVideoRotationaRotation)[pure virtual]

Rotates the video image on the screen.

7.0s

Parameters

TVideoRotation aRotationThe desired rotation to apply.

MvpcSetScaleFactorL(TReal32, TReal32, TBool)

voidMvpcSetScaleFactorL(TReal32aWidthPercentage,
TReal32aHeightPercentage,
TBoolaAntiAliasFiltering
)[pure virtual]

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

7.0s

Parameters

TReal32 aWidthPercentageThe percentage (100 = original size) to be used to scale the width of the video image.
TReal32 aHeightPercentageThe 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 aAntiAliasFilteringA 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.

MvpcUpdateDisplayRegionL(const TRegion &)

voidMvpcUpdateDisplayRegionL(const TRegion &aRegion)[pure virtual]

Updates the region to display.

7.0s

Parameters

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