MMMFVideoPlayControllerCustomCommandImplementor Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

class MMMFVideoPlayControllerCustomCommandImplementor

Public Member Functions
pure virtual void	MvpcDirectScreenAccessEventL(const TMMFDSAEvent)
pure virtual void	MvpcGetAudioEnabledL(TBool &)
pure virtual void	MvpcGetCropRegionL(TRect &)
pure virtual void	MvpcGetFrameL(MMMFVideoFrameMessage &)
pure virtual void	MvpcGetLoadingProgressL(TInt &)
pure virtual void	MvpcGetRotationL(TVideoRotation &)
pure virtual void	MvpcGetScaleFactorL(TReal32 &, TReal32 &, TBool &)
pure virtual void	MvpcPlayL(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
pure virtual void	MvpcPrepare()
pure virtual void	MvpcRefreshFrameL()
pure virtual void	MvpcSetCropRegionL(const TRect &)
pure virtual void	MvpcSetDisplayWindowL(const TRect &, const TRect &)
pure virtual void	MvpcSetRotationL(TVideoRotation)
pure virtual void	MvpcSetScaleFactorL(TReal32, TReal32, TBool)
pure virtual void	MvpcUpdateDisplayRegionL(const TRegion &)

Detailed 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.

Since: 7.0s

Member Function Documentation

MvpcDirectScreenAccessEventL ( const TMMFDSAEvent )

void

MvpcDirectScreenAccessEventL

(

const TMMFDSAEvent

aDSAEvent

)

[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.

Since: 7.0s

Parameters
aDSAEvent	Whether the video display should be active.

MvpcGetAudioEnabledL ( TBool & )

void

MvpcGetAudioEnabledL

(

TBool &

aEnabled

)

[pure virtual]

Indicates whether audio is enabled.

Since: 7.0s

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

MvpcGetCropRegionL ( TRect & )

void

MvpcGetCropRegionL

(

TRect &

aCropRegion

)

[pure virtual]

Gets the crop region currently applied to the image

been applied, the full dimensions of the video image will be returned.

Since: 7.0s

Parameters
aCropRegion	The dimensions of the crop region, relative to the video image. If no crop region has

MvpcGetFrameL ( MMMFVideoFrameMessage & )

void

MvpcGetFrameL

(

MMMFVideoFrameMessage &

aVideoFrame

)

[pure virtual]

Gets a frame previously requested from the controller.

Since: 7.0s

Parameters
aVideoFrame	The handle of bitmap to retrieve frame to.

MvpcGetLoadingProgressL ( TInt & )

void

MvpcGetLoadingProgressL

(

TInt &

aPercentageComplete

)

[pure virtual]

Gets the progress of loading a video clip.

Since: 7.0s

Parameters
aPercentageComplete	The progress loading the clip, as a percentage.

MvpcGetRotationL ( TVideoRotation & )

void

MvpcGetRotationL

(

TVideoRotation &

aRotation

)

[pure virtual]

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

Since: 7.0s

Parameters
aRotation	The applied rotation.

MvpcGetScaleFactorL ( TReal32 &, TReal32 &, TBool & )

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

Gets the scale factor currently applied to the video image.

copied into here.

filtering is being used, EFalse if not.

Since: 7.0s

Parameters
aWidthPercentage	The percentage (100 = original size) used to scale the width of the video image will be
aHeightPercentage	The percentage (100 = original size) used to scale the height of the video image will be
aAntiAliasFiltering	A boolean indicating if anti-aliasing filtering should be used. ETrue if anti-aliasing

MvpcPlayL ( const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds & )

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

Sets a time window for video playback.

Since: 7.0s

Parameters
aStart	Start time in milliseconds relative to the start of the video clip.
aEnd	End time in milliseconds relative to the start of the video clip.

MvpcPrepare ( )

void

MvpcPrepare

(

)

[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.

Since: 7.0s

MvpcRefreshFrameL ( )

void

MvpcRefreshFrameL

(

)

[pure virtual]

Requests the controller to redraw the current frame.

Since: 7.0s

MvpcSetCropRegionL ( const TRect & )

void

MvpcSetCropRegionL

(

const TRect &

aCropRegion

)

[pure virtual]

Selects a region of the video image to be displayed.

Since: 7.0s

Parameters
aCropRegion	The dimensions of the crop region, relative to the video image.

MvpcSetDisplayWindowL ( const TRect &, const TRect & )

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

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

Since: 7.0s

Parameters
aClipRect	The clip rect used to display the video.

MvpcSetRotationL ( TVideoRotation )

void

MvpcSetRotationL

(

TVideoRotation

aRotation

)

[pure virtual]

Rotates the video image on the screen.

Since: 7.0s

Parameters
aRotation	The desired rotation to apply.

MvpcSetScaleFactorL ( TReal32, TReal32, TBool )

void	MvpcSetScaleFactorL	(	TReal32	aWidthPercentage,
			TReal32	aHeightPercentage,
			TBool	aAntiAliasFiltering
		)	[pure virtual]

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

If this is not equal to aWidthPercentage then the image may be distorted.

should be used. If the plugin does not support this kind of processing, this value will

be ignored.

Since: 7.0s

Parameters
aWidthPercentage	The percentage (100 = original size) to be used to scale the width of the video image.
aHeightPercentage	The percentage (100 = original size) to be used to scale the height of the video image.
aAntiAliasFiltering	A boolean indicating if anit-aliasing filtering should be used. ETrue if anti-aliasing

MvpcUpdateDisplayRegionL ( const TRegion & )

void

MvpcUpdateDisplayRegionL

(

const TRegion &

aRegion

)

[pure virtual]

Updates the region to display.

transferred.

Since: 7.0s

Parameters
aRegion	A TRegion containing the current display regions, ownership of the TRegion is not