RMMFVideoPlayControllerCustomCommands Class Reference

#include <mmf/common/mmfstandardcustomcommands.h>

Link against: mmfstandardcustomcommands.lib

class RMMFVideoPlayControllerCustomCommands : public RMMFCustomCommandsBase, public RMMFCustomCommandsBase

Inherits from

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

Constructor & Destructor Documentation

RMMFVideoPlayControllerCustomCommands ( RMMFController & )

IMPORT_CRMMFVideoPlayControllerCustomCommands(RMMFController &aController)

Constructor.

Since
7.0s
Parameters
aControllerThe client side controller object to be used by this custom command interface.

Member Function Documentation

DirectScreenAccessEvent ( const TMMFDSAEvent )

IMPORT_C TIntDirectScreenAccessEvent(const TMMFDSAEventaDSAEvent)const

Sends a direct screen access event to controller.

Since
7.0s
Parameters
aDSAEventThe direct screen access event.
Return Value
One of the system-wide error codes.

GetAudioEnabled ( TBool & )

IMPORT_C TIntGetAudioEnabled(TBool &aEnabled)const

Queries whether audio is enabled.

Since
7.0s
Parameters
aEnabledA boolean indicating whether audio is enabled.
Return Value
One of the system-wide error codes.

GetCropRegion ( TRect & )

IMPORT_C TIntGetCropRegion(TRect &aCropRegion)const

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
aCropRegionThe dimensions of the crop region, relative to the video image. If no crop region has
Return Value
One of the system-wide error codes.

GetFrame ( CFbsBitmap &, TRequestStatus & )

IMPORT_C voidGetFrame(CFbsBitmap &aBitmap,
TRequestStatus &aStatus
)

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.

Since
7.0s
Parameters
aBitmapThe handle of the CFbsBitmap object to retrieve the frame to.
aStatusThe active object to call back on.
Return Value
One of the system-wide error codes.

GetLoadingProgress ( TInt & )

IMPORT_C TIntGetLoadingProgress(TInt &aPercentageProgress)const

Gets the video loading progress as a percentage.

Since
7.0s
Parameters
aPercentageProgressThe progress loading the clip, as a percentage.
Return Value
One of the system-wide error codes.

GetRotation ( TVideoRotation & )

IMPORT_C TIntGetRotation(TVideoRotation &aRotation)const

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

Since
7.0s
Parameters
aRotationThe applied rotation.
Return Value
One of the system wide error codes.

GetScaleFactor ( TReal32 &, TReal32 &, TBool & )

IMPORT_C TIntGetScaleFactor(TReal32 &aWidthPercentage,
TReal32 &aHeightPercentage,
TBool &aAntiAliasFiltering
)const

Gets the scale factor currently applied to the video image.

of the video image.

of the video image.

Since
7.0s
Parameters
aWidthPercentageOn return, will contain the percentage (100 = original size) used to scale the width
aHeightPercentageOn return. will contain the percentage (100 = original size) used to scale the height
aAntiAliasFilteringTrue if anti-aliasing filtering is being used
Return Value
One of the system wide error codes.

Play ( const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds & )

IMPORT_C TIntPlay(const TTimeIntervalMicroSeconds &aStart,
const TTimeIntervalMicroSeconds &aEnd
)const

Sets a time window for video playback.

Since
7.0s
Parameters
aStartThe start time in milliseconds relative to the start of the video clip.
aEndThe end time in milliseconds relative to the start of the video clip.
Return Value
One of the system-wide error codes.

Prepare ( )

IMPORT_C TIntPrepare()

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.

Since
7.0s

RefreshFrame ( )

IMPORT_C TIntRefreshFrame()const

Requests the controller to redraw the current frame.

Since
7.0s
Return Value
One of the system-wide error codes.

SetCropRegion ( const TRect & )

IMPORT_C TIntSetCropRegion(const TRect &aCropRegion)const

Selects a region of the video image to be displayed.

Since
7.0s
Parameters
aCropRegionThe dimensions of the crop region, relative to the video image.
Return Value
One of the system wide error codes.

SetDisplayWindow ( const TRect &, const TRect & )

IMPORT_C TIntSetDisplayWindow(const TRect &aWindowRect,
const TRect &aClipRect
)const

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

Since
7.0s
Parameters
aWindowRectThe window rectangle.
aClipRectThe clip rectangle.
Return Value
One of the system-wide error codes.

SetRotation ( TVideoRotation )

IMPORT_C TIntSetRotation(TVideoRotationaRotation)const

Rotates the video image on the screen.

Since
7.0s
Parameters
aRotationThe desired rotation to apply.
Return Value
One of the system-wide error codes.

SetScaleFactor ( TReal32, TReal32, TBool )

IMPORT_C TIntSetScaleFactor(TReal32aWidthPercentage,
TReal32aHeightPercentage,
TBoolaAntiAliasFiltering
)const

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.

support this kind of processing, this value will be ignored.

Since
7.0s
Parameters
aWidthPercentageThe percentage (100 = original size) to be used to scale the width of the video image.
aHeightPercentageThe percentage (100 = original size) to be used to scale the height of the video image.
aAntiAliasFilteringTrue if anti-aliasing filtering should be used. If the plugin does not
Return Value
One of the system wide error codes.

UpdateDisplayRegion ( const TRegion & )

IMPORT_C TIntUpdateDisplayRegion(const TRegion &aRegion)const

Updates the display region.

Since
7.0s
Parameters
aRegionThe valid region to display to.
Return Value
One of the system-wide error codes.