Collapse all Symbian^3 Application Developer Library

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.

Public Member Functions
void	MvpsusAddSubtitleConfigL (const TMMFSubtitleWindowConfig &)
void	MvpsusDisableSubtitlesL ()
void	MvpsusEnableSubtitlesL ()
void	MvpsusGetCrpParametersL ( TInt , TWsGraphicId &, TRect &)
void	MvpsusGetSubtitleLanguageL ( TLanguage &)
void	MvpsusGetSubtitlesAvailableL ( TBool &)
void	MvpsusGetSupportedSubtitleLanguagesL ( RArray < TLanguage > &)
void	MvpsusRemoveSubtitleConfigL ( TInt )
void	MvpsusSetSubtitleLanguageL ( TLanguage )
void	MvpsusUpdateSubtitleConfigL (const TMMFSubtitleWindowConfig &)

Member Functions Documentation

MvpsusAddSubtitleConfigL(const TMMFSubtitleWindowConfig &)

void

MvpsusAddSubtitleConfigL

(

const TMMFSubtitleWindowConfig &

aConfig

)

[pure virtual]

Adds subtitle configuration data for a window.

Parameters

const TMMFSubtitleWindowConfig & aConfig

Subtitle configuration data for a window.

MvpsusDisableSubtitlesL()

void

MvpsusDisableSubtitlesL

(

)

[pure virtual]

Disables subtitles during video playback.

leave: System wide error code

MvpsusEnableSubtitlesL()

void

MvpsusEnableSubtitlesL

(

)

[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 &)

void	MvpsusGetCrpParametersL	(	TInt	aWindowId,
			TWsGraphicId &	aId,
			TRect &	aCrpRect
		)	[pure virtual]

Gets the CRP parameters associated with a display

Parameters

TInt aWindowId	Unique identifier of the window.
TWsGraphicId & aId	Return the CRP id associated with the given display id
TRect & aCrpRect	Return the subtitle region for drawing the CRP

MvpsusGetSubtitleLanguageL(TLanguage &)

void

MvpsusGetSubtitleLanguageL

(

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 & aLanguage

When this method returns, this is set the the current subtitle language.

MvpsusGetSubtitlesAvailableL(TBool &)

void

MvpsusGetSubtitlesAvailableL

(

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 & aAvailable

When this method returns, this is set the ETrue if the current video stream subtitles.

MvpsusGetSupportedSubtitleLanguagesL(RArray< TLanguage > &)

void

MvpsusGetSupportedSubtitleLanguagesL

(

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 > & aAvailable

When this function returns, this array will hold the supported languages.

MvpsusRemoveSubtitleConfigL(TInt)

void

MvpsusRemoveSubtitleConfigL

(

TInt

aWindowId

)

[pure virtual]

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.

MvpsusSetSubtitleLanguageL(TLanguage)

void

MvpsusSetSubtitleLanguageL

(

TLanguage

aLanguage

)

[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 aLanguage

Language to be used for subtitle stream.

MvpsusUpdateSubtitleConfigL(const TMMFSubtitleWindowConfig &)

void

MvpsusUpdateSubtitleConfigL

(

const TMMFSubtitleWindowConfig &

aConfig

)

[pure virtual]

Reconfigures the subtitle configuration.

Parameters

const TMMFSubtitleWindowConfig & aConfig

Subtitle configuration data for a window.