MMMFVideoPlayControllerCustomCommandImplementor Class Reference
#include
"mmfstandardcustomcommands.h"
| class MMMFVideoPlayControllerCustomCommandImplementor |
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.
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.
| Parameter | Description | | aDSAEvent | Whether the video display should be active. |
MvpcGetAudioEnabledL ( TBool & )
| void | MvpcGetAudioEnabledL | ( | TBool & | aEnabled | ) | [pure virtual] |
Indicates whether audio is enabled.
| Parameter | Description | | 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
| Parameter | Description | | 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. |
MvpcGetFrameL ( MMMFVideoFrameMessage & )
Gets a frame previously requested from the controller.
| Parameter | Description | | 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.
| Parameter | Description | | aPercentageComplete | The progress loading the clip, as a percentage. |
MvpcGetRotationL ( TVideoRotation & )
Queries the rotation that is currently applied to the video image.
| Parameter | Description | | 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.
| Parameter | Description | | aWidthPercentage | The percentage (100 = original size) used to scale the width of the video image will be copied into here. |
| aHeightPercentage | The percentage (100 = original size) used to scale the height of the video image will be copied into here. |
| aAntiAliasFiltering | A boolean indicating if anti-aliasing filtering should be used. ETrue if anti-aliasing filtering is being used, EFalse if not. |
MvpcPlayL ( const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds & )
Sets a time window for video playback.
| Parameter | Description | | 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.
MvpcRefreshFrameL ( )
| void | MvpcRefreshFrameL | ( | ) | [pure virtual] |
Requests the controller to redraw the current frame.
MvpcSetCropRegionL ( const TRect & )
| void | MvpcSetCropRegionL | ( | const TRect & | aCropRegion | ) | [pure virtual] |
Selects a region of the video image to be displayed.
| Parameter | Description | | 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.
| Parameter | Description | | aClipRect | The clip rect used to display the video. |
MvpcSetRotationL ( TVideoRotation )
Rotates the video image on the screen.
| Parameter | Description | | 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.
| Parameter | Description | | 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. If this is not equal to aWidthPercentage then the image may be distorted. |
| aAntiAliasFiltering | A boolean indicating if anit-aliasing filtering should be used. ETrue if anti-aliasing should be used. If the plugin does not support this kind of processing, this value will be ignored. |
MvpcUpdateDisplayRegionL ( const TRegion & )
| void | MvpcUpdateDisplayRegionL | ( | const TRegion & | aRegion | ) | [pure virtual] |
Updates the region to display.
| Parameter | Description | | aRegion | A TRegion containing the current display regions, ownership of the TRegion is not transferred. |