Symbian^3 Application Developer Library >

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.

Since
7.0s

Inherits from

Public Member Functions
RMMFVideoPlayControllerCustomCommands ( RMMFController &)
IMPORT_C TInt DirectScreenAccessEvent (const TMMFDSAEvent )
IMPORT_C TInt GetAudioEnabled ( TBool &)
IMPORT_C TInt GetCropRegion ( TRect &)
IMPORT_C void GetFrame ( CFbsBitmap &, TRequestStatus &)
IMPORT_C TInt GetLoadingProgress ( TInt &)
IMPORT_C TInt GetRotation ( TVideoRotation &)
IMPORT_C TInt GetScaleFactor ( TReal32 &, TReal32 &, TBool &)
IMPORT_C TInt Play (const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
IMPORT_C TInt Prepare ()
IMPORT_C TInt RefreshFrame ()
IMPORT_C TInt SetCropRegion (const TRect &)
IMPORT_C TInt SetDisplayWindow (const TRect &, const TRect &)
IMPORT_C TInt SetRotation ( TVideoRotation )
IMPORT_C TInt SetScaleFactor ( TReal32 , TReal32 , TBool )
IMPORT_C TInt UpdateDisplayRegion (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_C RMMFVideoPlayControllerCustomCommands ( RMMFController & aController )

Constructor.

Since
7.0s

Parameters

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

Member Functions Documentation

DirectScreenAccessEvent(const TMMFDSAEvent)

IMPORT_C TInt DirectScreenAccessEvent ( const TMMFDSAEvent aDSAEvent ) const

Sends a direct screen access event to controller.

Since
7.0s

Parameters

const TMMFDSAEvent aDSAEvent The direct screen access event.

GetAudioEnabled(TBool &)

IMPORT_C TInt GetAudioEnabled ( TBool & aEnabled ) const

Queries whether audio is enabled.

Since
7.0s

Parameters

TBool & aEnabled A boolean indicating whether audio is enabled.

GetCropRegion(TRect &)

IMPORT_C TInt GetCropRegion ( TRect & aCropRegion ) const

Gets the crop region currently applied to the image.

Since
7.0s

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.

GetFrame(CFbsBitmap &, TRequestStatus &)

IMPORT_C void GetFrame ( 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

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

GetLoadingProgress(TInt &)

IMPORT_C TInt GetLoadingProgress ( TInt & aPercentageProgress ) const

Gets the video loading progress as a percentage.

Since
7.0s

Parameters

TInt & aPercentageProgress The progress loading the clip, as a percentage.

GetRotation(TVideoRotation &)

IMPORT_C TInt GetRotation ( TVideoRotation & aRotation ) const

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

Since
7.0s

Parameters

TVideoRotation & aRotation The applied rotation.

GetScaleFactor(TReal32 &, TReal32 &, TBool &)

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

Gets the scale factor currently applied to the video image.

Since
7.0s

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

Play(const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

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

Sets a time window for video playback.

Since
7.0s

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.

Prepare()

IMPORT_C TInt Prepare ( )

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 TInt RefreshFrame ( ) const

Requests the controller to redraw the current frame.

Since
7.0s

SetCropRegion(const TRect &)

IMPORT_C TInt SetCropRegion ( const TRect & aCropRegion ) const

Selects a region of the video image to be displayed.

Since
7.0s

Parameters

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

SetDisplayWindow(const TRect &, const TRect &)

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

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

Since
7.0s

Parameters

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

SetRotation(TVideoRotation)

IMPORT_C TInt SetRotation ( TVideoRotation aRotation ) const

Rotates the video image on the screen.

Since
7.0s

Parameters

TVideoRotation aRotation The desired rotation to apply.

SetScaleFactor(TReal32, TReal32, TBool)

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

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

Since
7.0s

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.

UpdateDisplayRegion(const TRegion &)

IMPORT_C TInt UpdateDisplayRegion ( const TRegion & aRegion ) const

Updates the display region.

Since
7.0s

Parameters

const TRegion & aRegion The valid region to display to.

Member Data Documentation

TPckgBuf< TMMFVideoConfig > iConfigPackage

TPckgBuf < TMMFVideoConfig > iConfigPackage [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.