#include <mmfstandardcustomcommands.h>
Link against: mmfstandardcustomcommands.lib

Class `RMMFVideoPlayControllerCustomCommands`

class RMMFVideoPlayControllerCustomCommands : public RMMFCustomCommandsBase;

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.

Derivation

RMMFCustomCommandsBase - Base class for client-side custom command classes.

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

Members

Defined in RMMFVideoPlayControllerCustomCommands:

DirectScreenAccessEvent(const TMMFDSAEvent)constSends a direct screen access event to controller.
GetAudioEnabled(TBool &)constQueries whether audio is enabled.
GetCropRegion(TRect &)constGets the crop region currently applied to the image.
GetFrame(CFbsBitmap &,TRequestStatus &)Asks the controller to store the current frame to a bitmap.
GetLoadingProgress(TInt &)constGets the video loading progress as a percentage.
GetRotation(TVideoRotation &)constQueries the rotation that is currently applied to the video image.
GetScaleFactor(TReal32 &,TReal32 &,TBool &)constGets the scale factor currently applied to the video image.
Play(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &)constSets a time window for video playback.
Prepare()Prepares the video clip to be accessed.
RMMFVideoPlayControllerCustomCommands(RMMFController &)Constructor.
RefreshFrame()constRequests the controller to redraw the current frame.
SetCropRegion(const TRect &)constSelects a region of the video image to be displayed.
SetDisplayWindow(const TRect &,const TRect &)constSets the screen region to be used to display the video.
SetRotation(TVideoRotation)constRotates the video image on the screen.
SetScaleFactor(TReal32,TReal32,TBool)constScales the video image to a specified percentage of its original size.
UpdateDisplayRegion(const TRegion &)constUpdates the display region.

Inherited from RMMFCustomCommandsBase:

RMMFCustomCommandsBase(RMMFController &,TUid)Constructor.
iControllerThe controller.
iDestinationPckgThe destination package.

Construction and destruction

`RMMFVideoPlayControllerCustomCommands(RMMFController &)`

IMPORT_C RMMFVideoPlayControllerCustomCommands(RMMFController &aController);

Description

Constructor.

Parameters


                                 						RMMFController &aController

The client side controller object to be used by this custom command interface.

Member functions

`Prepare()`

IMPORT_C TInt Prepare();

Description

Prepares the video clip to be accessed.

A call to this function tells the loaded 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.

Return value

TInt

`GetFrame(CFbsBitmap &,TRequestStatus &)`

IMPORT_C void GetFrame(CFbsBitmap &aBitmap, TRequestStatus &aStatus);

Description

Asks the controller to store the current frame to a bitmap.

The video play controller will send an event to the client on completion of the task.

Parameters

`CFbsBitmap &aBitmap`	The handle of the `CFbsBitmap` object to retrieve the frame to.
`TRequestStatus &aStatus`	The active object to call back on.

`SetDisplayWindow(const TRect &,const TRect &)const`

IMPORT_C TInt SetDisplayWindow(const TRect &aWindowRect, const TRect &aClipRect) const;

Description

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

Parameters

`const TRect &aWindowRect`	The window rectangle.
`const TRect &aClipRect`	The clip rectangle.

Return value

TInt

One of the system-wide error codes.

`UpdateDisplayRegion(const TRegion &)const`

IMPORT_C TInt UpdateDisplayRegion(const TRegion &aRegion) const;

Description

Updates the display region.

Parameters

const TRegion &aRegion

The valid region to display to.

Return value

TInt

One of the system-wide error codes.

`GetAudioEnabled(TBool &)const`

IMPORT_C TInt GetAudioEnabled(TBool &aEnabled) const;

Description

Queries whether audio is enabled.

Parameters


                                 						TBool &aEnabled

A boolean indicating whether audio is enabled.

Return value

TInt

One of the system-wide error codes.

`DirectScreenAccessEvent(const TMMFDSAEvent)const`

IMPORT_C TInt DirectScreenAccessEvent(const TMMFDSAEvent aDSAEvent) const;

Description

Sends a direct screen access event to controller.

Parameters

const TMMFDSAEvent aDSAEvent

The direct screen access event.

Return value

TInt

One of the system-wide error codes.

`Play(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &)const`

IMPORT_C TInt Play(const TTimeIntervalMicroSeconds &aStart, const TTimeIntervalMicroSeconds &aEnd) const;

Description

Sets a time window for video playback.

Parameters

`const TTimeIntervalMicroSeconds &aStart`	The start time in milliseconds relative to the start of the video clip.
`const TTimeIntervalMicroSeconds &aEnd`	The end time in milliseconds relative to the start of the video clip.

Return value

TInt

One of the system-wide error codes.

`RefreshFrame()const`

IMPORT_C TInt RefreshFrame() const;

Description

Requests the controller to redraw the current frame.

Return value

TInt

One of the system-wide error codes.

`GetLoadingProgress(TInt &)const`

IMPORT_C TInt GetLoadingProgress(TInt &aPercentageProgress) const;

Description

Gets the video loading progress as a percentage.

Parameters


                                 						TInt &aPercentageProgress

The progress loading the clip, as a percentage.

Return value

TInt

One of the system-wide error codes.

`SetRotation(TVideoRotation)const`

IMPORT_C TInt SetRotation(TVideoRotation aRotation) const;

Description

Rotates the video image on the screen.

Parameters


                                 						TVideoRotation aRotation

The desired rotation to apply.

Return value

TInt

One of the system-wide error codes.

`GetRotation(TVideoRotation &)const`

IMPORT_C TInt GetRotation(TVideoRotation &aRotation) const;

Description

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

Parameters


                                 						TVideoRotation &aRotation

The applied rotation.

Return value

TInt

One of the system wide error codes.

`SetScaleFactor(TReal32,TReal32,TBool)const`

IMPORT_C TInt SetScaleFactor(TReal32 aWidthPercentage, TReal32 aHeightPercentage, TBool aAntiAliasFiltering) const;

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`	True if anti-aliasing filtering should be used. If the plugin does not support this kind of processing, this value will be ignored.

Return value

TInt

One of the system wide error codes.

`GetScaleFactor(TReal32 &,TReal32 &,TBool &)const`

IMPORT_C TInt GetScaleFactor(TReal32 &aWidthPercentage, TReal32 &aHeightPercentage, TBool &aAntiAliasFiltering) const;

Description

Gets the scale factor currently applied to the video image.

Parameters

`TReal32 &aWidthPercentage`	On return, will contain the percentage (100 = original size) used to scale the width of the video image.
`TReal32 &aHeightPercentage`	On return. will contain the percentage (100 = original size) used to scale the height of the video image.
`TBool &aAntiAliasFiltering`	True if anti-aliasing filtering is being used

Return value

TInt

One of the system wide error codes.

`SetCropRegion(const TRect &)const`

IMPORT_C TInt SetCropRegion(const TRect &aCropRegion) const;

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.

Return value

TInt

One of the system wide error codes.

`GetCropRegion(TRect &)const`

IMPORT_C TInt GetCropRegion(TRect &aCropRegion) const;

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.

Return value

TInt

One of the system-wide error codes.

Class RMMFVideoPlayControllerCustomCommands

Description

Derivation

Members

Construction and destruction

RMMFVideoPlayControllerCustomCommands(RMMFController &)

Description

Parameters

Member functions

Prepare()

Description

Return value

GetFrame(CFbsBitmap &,TRequestStatus &)

Description

Parameters

SetDisplayWindow(const TRect &,const TRect &)const

Description

Parameters

Return value

UpdateDisplayRegion(const TRegion &)const

Description

Parameters

Return value

GetAudioEnabled(TBool &)const

Description

Parameters

Return value

DirectScreenAccessEvent(const TMMFDSAEvent)const

Description

Parameters

Return value

Play(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &)const

Description

Parameters

Return value

RefreshFrame()const

Description

Return value

GetLoadingProgress(TInt &)const

Description

Parameters

Return value

SetRotation(TVideoRotation)const

Description

Parameters

Return value

GetRotation(TVideoRotation &)const

Description

Parameters

Return value

SetScaleFactor(TReal32,TReal32,TBool)const

Description

Parameters

Return value

GetScaleFactor(TReal32 &,TReal32 &,TBool &)const

Description

Parameters

Return value

SetCropRegion(const TRect &)const

Description

Parameters

Return value

GetCropRegion(TRect &)const

Description

Parameters

Return value

Class `RMMFVideoPlayControllerCustomCommands`

`RMMFVideoPlayControllerCustomCommands(RMMFController &)`

`Prepare()`

`GetFrame(CFbsBitmap &,TRequestStatus &)`

`SetDisplayWindow(const TRect &,const TRect &)const`

`UpdateDisplayRegion(const TRegion &)const`

`GetAudioEnabled(TBool &)const`

`DirectScreenAccessEvent(const TMMFDSAEvent)const`

`Play(const TTimeIntervalMicroSeconds &,const TTimeIntervalMicroSeconds &)const`

`RefreshFrame()const`

`GetLoadingProgress(TInt &)const`

`SetRotation(TVideoRotation)const`

`GetRotation(TVideoRotation &)const`

`SetScaleFactor(TReal32,TReal32,TBool)const`

`GetScaleFactor(TReal32 &,TReal32 &,TBool &)const`

`SetCropRegion(const TRect &)const`

`GetCropRegion(TRect &)const`