RMMFVideoPlayControllerCustomCommands Class Reference

class RMMFVideoPlayControllerCustomCommands : public RMMFCustomCommandsBase

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

Inherits from

Public Member Functions
RMMFVideoPlayControllerCustomCommands(RMMFController &)
IMPORT_C TIntDirectScreenAccessEvent(const TMMFDSAEvent)
IMPORT_C TIntGetAudioEnabled(TBool &)
IMPORT_C TIntGetCropRegion(TRect &)
IMPORT_C voidGetFrame(CFbsBitmap &, TRequestStatus &)
IMPORT_C TIntGetLoadingProgress(TInt &)
IMPORT_C TIntGetRotation(TVideoRotation &)
IMPORT_C TIntGetScaleFactor(TReal32 &, TReal32 &, TBool &)
IMPORT_C TIntPlay(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
IMPORT_C TIntPrepare()
IMPORT_C TIntRefreshFrame()
IMPORT_C TIntSetCropRegion(const TRect &)
IMPORT_C TIntSetDisplayWindow(const TRect &, const TRect &)
IMPORT_C TIntSetRotation(TVideoRotation)
IMPORT_C TIntSetScaleFactor(TReal32, TReal32, TBool)
IMPORT_C TIntUpdateDisplayRegion(const TRegion &)
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)
Private Attributes
TPckgBuf< TMMFVideoConfig >iConfigPackage
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg

Constructor & Destructor Documentation

RMMFVideoPlayControllerCustomCommands(RMMFController &)

IMPORT_CRMMFVideoPlayControllerCustomCommands(RMMFController &aController)

Constructor.

7.0s

Parameters

RMMFController & aControllerThe client side controller object to be used by this custom command interface.

Member Functions Documentation

DirectScreenAccessEvent(const TMMFDSAEvent)

IMPORT_C TIntDirectScreenAccessEvent(const TMMFDSAEventaDSAEvent)const

Sends a direct screen access event to controller.

One of the system-wide error codes.

7.0s

Parameters

const TMMFDSAEvent aDSAEventThe direct screen access event.

GetAudioEnabled(TBool &)

IMPORT_C TIntGetAudioEnabled(TBool &aEnabled)const

Queries whether audio is enabled.

One of the system-wide error codes.

7.0s

Parameters

TBool & aEnabledA boolean indicating whether audio is enabled.

GetCropRegion(TRect &)

IMPORT_C TIntGetCropRegion(TRect &aCropRegion)const

Gets the crop region currently applied to the image.

One of the system-wide error codes.

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.

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.

One of the system-wide error codes.

7.0s

Parameters

CFbsBitmap & aBitmapThe handle of the CFbsBitmap object to retrieve the frame to.
TRequestStatus & aStatusThe active object to call back on.

GetLoadingProgress(TInt &)

IMPORT_C TIntGetLoadingProgress(TInt &aPercentageProgress)const

Gets the video loading progress as a percentage.

One of the system-wide error codes.

7.0s

Parameters

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

GetRotation(TVideoRotation &)

IMPORT_C TIntGetRotation(TVideoRotation &aRotation)const

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

One of the system wide error codes.

7.0s

Parameters

TVideoRotation & aRotationThe applied rotation.

GetScaleFactor(TReal32 &, TReal32 &, TBool &)

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

Gets the scale factor currently applied to the video image.

One of the system wide error codes.

7.0s

Parameters

TReal32 & aWidthPercentageOn return, will contain the percentage (100 = original size) used to scale the width of the video image.
TReal32 & aHeightPercentageOn return. will contain the percentage (100 = original size) used to scale the height of the video image.
TBool & aAntiAliasFilteringTrue if anti-aliasing filtering is being used

Play(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

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

Sets a time window for video playback.

One of the system-wide error codes.

7.0s

Parameters

const TTimeIntervalMicroSeconds & aStartThe start time in milliseconds relative to the start of the video clip.
const TTimeIntervalMicroSeconds & aEndThe end time in milliseconds relative to the start of the video clip.

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.

7.0s

RefreshFrame()

IMPORT_C TIntRefreshFrame()const

Requests the controller to redraw the current frame.

One of the system-wide error codes.

7.0s

SetCropRegion(const TRect &)

IMPORT_C TIntSetCropRegion(const TRect &aCropRegion)const

Selects a region of the video image to be displayed.

One of the system wide error codes.

7.0s

Parameters

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

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.

One of the system-wide error codes.

7.0s

Parameters

const TRect & aWindowRectThe window rectangle.
const TRect & aClipRectThe clip rectangle.

SetRotation(TVideoRotation)

IMPORT_C TIntSetRotation(TVideoRotationaRotation)const

Rotates the video image on the screen.

One of the system-wide error codes.

7.0s

Parameters

TVideoRotation aRotationThe desired rotation to apply.

SetScaleFactor(TReal32, TReal32, TBool)

IMPORT_C TIntSetScaleFactor(TReal32aWidthPercentage,
TReal32aHeightPercentage,
TBoolaAntiAliasFiltering
)const

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

One of the system wide error codes.

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

UpdateDisplayRegion(const TRegion &)

IMPORT_C TIntUpdateDisplayRegion(const TRegion &aRegion)const

Updates the display region.

One of the system-wide error codes.

7.0s

Parameters

const TRegion & aRegionThe valid region to display to.

Member Data Documentation

TPckgBuf< TMMFVideoConfig > iConfigPackage

TPckgBuf< TMMFVideoConfig >iConfigPackage[private]
© Nokia 2010.