MMMFVideoPlaySubtitleSupportCustomCommandImplementor Class Reference

class MMMFVideoPlaySubtitleSupportCustomCommandImplementor

Mixin class for subtitle custom commands implemented by the controller. The custom command parser calls methods in this class to deliver the requests to the controller.

Member Functions Documentation

MvpsusAddSubtitleConfigL(const TMMFSubtitleWindowConfig &)

voidMvpsusAddSubtitleConfigL(const TMMFSubtitleWindowConfig &aConfig)[pure virtual]

Adds subtitle configuration data for a window.

Parameters

const TMMFSubtitleWindowConfig & aConfigSubtitle configuration data for a window.

MvpsusDisableSubtitlesL()

voidMvpsusDisableSubtitlesL()[pure virtual]

Disables subtitles during video playback.

leave
System wide error code

MvpsusEnableSubtitlesL()

voidMvpsusEnableSubtitlesL()[pure virtual]

Enables subtitles during video playback.

leave
KErrNotSupported if subtitles are not supported
leave
KErrNotFound if subtitle data is not found
leave
Otherwise leaves with any of the system wide error codes.

MvpsusGetCrpParametersL(TInt, TWsGraphicId &, TRect &)

voidMvpsusGetCrpParametersL(TIntaWindowId,
TWsGraphicId &aId,
TRect &aCrpRect
)[pure virtual]

Gets the CRP parameters associated with a display

Parameters

TInt aWindowIdUnique identifier of the window.
TWsGraphicId & aIdReturn the CRP id associated with the given display id
TRect & aCrpRectReturn the subtitle region for drawing the CRP

MvpsusGetSubtitleLanguageL(TLanguage &)

voidMvpsusGetSubtitleLanguageL(TLanguage &aLanguage)[pure virtual]

Gets the current subtitle language

leave
KErrNotSupported The enabled subtitle does not contain language information.
leave
Otherwise leaves with any of the system wide error codes.

Parameters

TLanguage & aLanguageWhen this method returns, this is set the the current subtitle language.

MvpsusGetSubtitlesAvailableL(TBool &)

voidMvpsusGetSubtitlesAvailableL(TBool &aAvailable)[pure virtual]

Checks if subtitles are available in the current video stream.

leave
KErrNotSupported if the controller does not support subtitles. Otherwise another system-wide error code.

Parameters

TBool & aAvailableWhen this method returns, this is set the ETrue if the current video stream subtitles.

MvpsusGetSupportedSubtitleLanguagesL(RArray< TLanguage > &)

voidMvpsusGetSupportedSubtitleLanguagesL(RArray< TLanguage > &aAvailable)[pure virtual]

Gets array of all supported languages that are available in the current video player.

leave
KErrNotSupported The enabled subtitle does not contain language information
leave
Otherwise leaves with any of the system wide error codes.

Parameters

RArray< TLanguage > & aAvailableWhen this function returns, this array will hold the supported languages.

MvpsusRemoveSubtitleConfigL(TInt)

voidMvpsusRemoveSubtitleConfigL(TIntaWindowId)[pure virtual]

Removes the subtitle configuration data associated with the given window.

Parameters

TInt aWindowIdUnique identifier of the window associated with the configuration data being removed.

MvpsusSetSubtitleLanguageL(TLanguage)

voidMvpsusSetSubtitleLanguageL(TLanguageaLanguage)[pure virtual]

Sets the current subtitle language

leave
KErrNotSupported The enabled subtitle does not support the requested language.
leave
Otherwise leaves with any of the system wide error codes.

Parameters

TLanguage aLanguageLanguage to be used for subtitle stream.

MvpsusUpdateSubtitleConfigL(const TMMFSubtitleWindowConfig &)

voidMvpsusUpdateSubtitleConfigL(const TMMFSubtitleWindowConfig &aConfig)[pure virtual]

Reconfigures the subtitle configuration.

Parameters

const TMMFSubtitleWindowConfig & aConfigSubtitle configuration data for a window.