RMMFVideoPlaySubtitleSupportCustomCommands Class Reference
| class RMMFVideoPlaySubtitleSupportCustomCommands : public RMMFCustomCommandsBase |
Client class to access functionality specific to a subtitle supported 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
- RMMFVideoPlaySubtitleSupportCustomCommands
Constructor & Destructor Documentation
RMMFVideoPlaySubtitleSupportCustomCommands(RMMFController &)
| IMPORT_C | RMMFVideoPlaySubtitleSupportCustomCommands | ( | RMMFController & | aController | ) | |
Parameters
| RMMFController & aController | The client side controller object to be used by this custom command interface. |
Member Functions Documentation
AddSubtitleConfig(const TMMFSubtitleWindowConfig &)
Adds subtitle configuration data for a window.
DisableSubtitles()
| IMPORT_C TInt | DisableSubtitles | ( | ) | |
Disables subtitles during video playback.
EnableSubtitles()
| IMPORT_C TInt | EnableSubtitles | ( | ) | |
Enables subtitles during video playback.
GetCrpParameters(TInt, TWsGraphicId &, TRect &)
Gets the CRP parameters associated with a display
Parameters
| TInt aWindowId | The window id used in the query. |
| TWsGraphicId & aId | Return the CRP id associated with the given display id |
| TRect & aCrpRect | Return the subtitle region for drawing the CRP |
GetSubtitleLanguage(TLanguage &)
Gets the current subtitle language
Parameters
| TLanguage & aLanguage | On return, set the the current language. |
GetSubtitlesAvailable(TBool &)
| IMPORT_C TInt | GetSubtitlesAvailable | ( | TBool & | aAvailable | ) | |
Checks if subtitles are available in the current video stream.
Parameters
| TBool & aAvailable | When this function returns, this is set to ETrue if the controller supports subtitle extensions and subtitles are available in the current video stream. |
GetSupportedSubtitleLanguagesL(RArray< TLanguage > &)
| IMPORT_C void | GetSupportedSubtitleLanguagesL | ( | RArray< TLanguage > & | aSubtitleLanguages | ) | |
Gets a list of all available languages.
-
leave
- KErrNotSupported If the current controller does not support subtitles.
-
leave
- KErrNotFound If the controller cannot find subtitle data.
-
leave
- Otherwise leaves with any of the system wide error codes.
RemoveSubtitleConfig(TInt)
| IMPORT_C TInt | RemoveSubtitleConfig | ( | TInt | aWindowId | ) | |
Removes the subtitle configuration data associated with the given window.
Parameters
| TInt aWindowId | Unique identifier of the window associated with the configuration data being removed. |
SetSubtitleLanguage(TLanguage)
Sets the current subtitle language
Parameters
| TLanguage aSubtitleLanguage | Language to be used for subtitle stream. |
UpdateSubtitleConfig(const TMMFSubtitleWindowConfig &)
Reconfigures subtitle configuration.
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.