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.
Inherits from
- RMMFVideoPlayControllerCustomCommands
Constructor & Destructor Documentation
RMMFVideoPlayControllerCustomCommands(RMMFController &)
| IMPORT_C | RMMFVideoPlayControllerCustomCommands | ( | RMMFController & | aController | ) | |
Parameters
| RMMFController & aController | The client side controller object to be used by this custom command interface. |
Member Functions Documentation
DirectScreenAccessEvent(const TMMFDSAEvent)
Sends a direct screen access event to controller.
GetAudioEnabled(TBool &)
| IMPORT_C TInt | GetAudioEnabled | ( | TBool & | aEnabled | ) | const |
Queries whether audio is enabled.
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.
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 &)
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. |
GetLoadingProgress(TInt &)
| IMPORT_C TInt | GetLoadingProgress | ( | TInt & | aPercentageProgress | ) | const |
Gets the video loading progress as a percentage.
Parameters
| TInt & aPercentageProgress | The progress loading the clip, as a percentage. |
GetRotation(TVideoRotation &)
Queries the rotation that is currently applied to the video image.
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.
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 &)
Sets a time window for video playback.
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.
RefreshFrame()
| IMPORT_C TInt | RefreshFrame | ( | ) | const |
Requests the controller to redraw the current frame.
SetCropRegion(const TRect &)
| IMPORT_C TInt | SetCropRegion | ( | const TRect & | aCropRegion | ) | const |
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. |
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.
Parameters
| const TRect & aWindowRect | The window rectangle. |
| const TRect & aClipRect | The clip rectangle. |
SetRotation(TVideoRotation)
Rotates the video image on the screen.
SetScaleFactor(TReal32, TReal32, TBool)
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. |
UpdateDisplayRegion(const TRegion &)
| IMPORT_C TInt | UpdateDisplayRegion | ( | const TRegion & | aRegion | ) | const |
Updates the display region.
Parameters
| const TRegion & aRegion | The valid region to display to. |
Member Data Documentation
TPckgBuf< TMMFVideoConfig > iConfigPackage
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.