class CSmilPlayerDialog : public CAknDialog |
CSmilPlayerDialog dialog class This is an interface class for applications to use SmilPlayer. Derived from CAknDialog to enable options menu.
Usage: ----------------------- Copy & Paste ------------------------------- include <smilplayerdialog.h> //to the .cpp file where the following //is going to be used
CSmilPlayerDialog* dialog = CSmilPlayerDialog::NewL ( CMDXMLDocument* aDOM, MMediaFactoryFileInfo* aFileInfo, const TDesC& aBaseUrl, TBool aPreview = EFalse, TBool aAudioOn = EFalse );
or
CSmilPlayerDialog* dialog = CSmilPlayerDialog::NewL ( RFile & aFileHandle, MMediaFactoryFileInfo* aFileInfo, const TDesC& aBaseUrl, TBool aPreview = EFalse, TBool aAudioOn = EFalse );
dialog-> ExecuteLD() ; --------------------------------------------------------------------
Link agains library: smilplayer.lib. The dialog will be automatically destroyed by ExecuteLD.
Public Member Functions | |
---|---|
~CSmilPlayerDialog () | |
void | DeactivateScrollingL () |
IMPORT_C TInt | ExecuteLD () |
void | HandleGainingForeground () |
void | HandleLosingForeground () |
TKeyResponse | HandleSelectionKeyL () |
void | MrccatoCommand ( TRemConCoreApiOperationId , TRemConCoreApiButtonAction ) |
IMPORT_C CSmilPlayerDialog * | NewL ( CMDXMLDocument *, MMediaFactoryFileInfo *, const TDesC &, TBool , TBool ) |
IMPORT_C CSmilPlayerDialog * | NewL ( RFile &, MMediaFactoryFileInfo *, const TDesC &, TBool , TBool ) |
TKeyResponse | OfferKeyEventL (const TKeyEvent &, TEventCode ) |
void | PauseTappedL () |
void | PlayTappedL () |
void | PresentationStoppedL () |
void | ProcessCommandL ( TInt ) |
Protected Member Functions | |
---|---|
void | DynInitMenuOptionsAtNormalEnd (CEikMenuPane *) |
void | DynInitMenuOptionsL (CEikMenuPane *) |
void | DynInitMenuPaneL ( TInt , CEikMenuPane *) |
void | GetHelpContext ( TCoeHelpContext &) |
void | HandleResourceChange ( TInt ) |
TBool | OkToExitL ( TInt ) |
Private Member Functions | |
---|---|
CSmilPlayerDialog () | |
CSmilPlayerDialog ( TBool , TBool ) | |
void | ActivateL () |
void | ActivateScrollingL () |
TBool | AudioEnabled () |
void | ChangeStateL ( TSmilPlayerPresentationStates ) |
void | ClosePlayer () |
void | CommonConstructL () |
void | ConstructL (const TDesC &, MMediaFactoryFileInfo *, CMDXMLDocument *) |
void | ConstructL (const TDesC &, MMediaFactoryFileInfo *, RFile &) |
TInt | DoClosePlayer ( TAny *) |
void | DoFindItemL ( TInt ) |
void | DoReplayL () |
TInt | DoStopTiming ( TAny *) |
TInt | DoVolumeRepeat ( TAny *) |
TKeyResponse | HandleKeyEventL (const TKeyEvent &, TEventCode ) |
TKeyResponse | HandleScrollKeyL (const TKeyEvent &, TEventCode ) |
TKeyResponse | HandleVolumeKeyL (const TKeyEvent &, TEventCode ) |
void | LaunchHelpL () |
void | LayoutOverlappedPresentation () |
void | LayoutPresentationL () |
TRect | PresentationRect () |
void | ShowInformationNoteL ( TInt , TBool ) |
void | ShowMenubarL ( TInt ) |
void | StopTiming () |
void | VolumeRepeat () |
Private Member Enumerations | |
---|---|
enum | TSmilPlayerFlags { EPreview = 0x0001, EAudioOn = 0x0002, EHelpSupported = 0x0004, EScrollingActivated = 0x0008, EFeatureSideVolumeKeys = 0x0010 } |
enum | TSmilPlayerPresentationStates { ESmilPlayerStateNotReady = 0, ESmilPlayerStatePlaying , ESmilPlayerStatePause , ESmilPlayerStateStop } |
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType |
Private Attributes | |
---|---|
CRemConCoreApiTarget * | iCoreTarget |
CFindItemMenu * | iFindItemMenu |
CRemConInterfaceSelector * | iInterfaceSelector |
TInt | iPlayerFlags |
CSmilPlayerPresentationController * | iPresentationController |
TSmilPlayerPresentationStates | iPresentationState |
CPeriodic * | iRCSTimer |
TRemConCoreApiOperationId | iRepeatId |
RConeResourceLoader | iResLoader |
CPeriodic * | iTimer |
Inherited Attributes | |
---|---|
CAknDialog::iMenuBar | |
CCoeControl::iCoeEnv | |
CCoeControl::iContext | |
CCoeControl::iPosition | |
CCoeControl::iSize | |
CEikBorderedControl::iBorder |
CSmilPlayerDialog | ( | TBool | aPreview, |
TBool | aAudioOn | ||
) | [private] |
C++ constructor.
void | ChangeStateL | ( | TSmilPlayerPresentationStates | aState | ) | [private] |
Changes the state of the player to given one.
TSmilPlayerPresentationStates aState | New state |
void | ClosePlayer | ( | ) | [private] |
Exits the player. Indirectly called by the callback function DoCloseTiming.
void | CommonConstructL | ( | ) | [private] |
Common 2nd phase constructor shared by two overloaded ConstructL functions.
void | ConstructL | ( | const TDesC & | aBaseUrl, |
MMediaFactoryFileInfo * | aFileInfo, | |||
CMDXMLDocument * | aDOM | |||
) | [private] |
Symbian 2nd phase constructor.
const TDesC & aBaseUrl | |
MMediaFactoryFileInfo * aFileInfo | |
CMDXMLDocument * aDOM |
void | ConstructL | ( | const TDesC & | aBaseUrl, |
MMediaFactoryFileInfo * | aFileInfo, | |||
RFile & | aFileHandle | |||
) | [private] |
Symbian 2nd phase constructor.
TInt | DoClosePlayer | ( | TAny * | aObject | ) | [private, static] |
Callback function to stop timer This timer is used for showing the error note when .smil file is corrupted and player could be opened.
TAny * aObject |
void | DoFindItemL | ( | TInt | aCommandId | ) | [private] |
Implements the find item command. Activates the find item common component.
TInt aCommandId |
TInt | DoStopTiming | ( | TAny * | aObject | ) | [private, static] |
Callback function to stop timer This timer is used for waiting one second before getting back to the start.
TAny * aObject |
TInt | DoVolumeRepeat | ( | TAny * | aObject | ) | [private, static] |
Callback function to do volume repeat. This timer is used for repeating remote control server volume up/down command.
TAny * aObject |
void | DynInitMenuOptionsAtNormalEnd | ( | CEikMenuPane * | aMenuPane | ) | [protected] |
DynInitMenuOptionsAtNormalEnd Initializes items on the menu
CEikMenuPane * aMenuPane | Pointer to menupane |
void | DynInitMenuOptionsL | ( | CEikMenuPane * | aMenuPane | ) | [protected] |
DynInitMenuOptionsL Initializes items on the menu
CEikMenuPane * aMenuPane | Pointer to menupane |
void | DynInitMenuPaneL | ( | TInt | aMenuId, |
CEikMenuPane * | aMenuPane | |||
) | [protected, virtual] |
From MEikMenuObserver Initializes items on the menu
TInt aMenuId | Current menu's resource Id |
CEikMenuPane * aMenuPane | Pointer to menupane |
IMPORT_C TInt | ExecuteLD | ( | ) |
Initializes the dialog and calls CAknDialog's ExecuteLD() This method need to be called to execute the dialog. After exiting the dialog gets automatically destroyed
void | GetHelpContext | ( | TCoeHelpContext & | aContext | ) | const [protected, virtual] |
From CCoeControl This function is called when Help application is launched.
TCoeHelpContext & aContext | Help context |
void | HandleGainingForeground | ( | ) |
From MCoeForegroundObserver Prosesses foreground event.
TKeyResponse | HandleKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [private] |
Performs key event handling
const TKeyEvent & aKeyEvent | |
TEventCode aType |
void | HandleLosingForeground | ( | ) |
From MCoeForegroundObserver Prosesses foreground event.
void | HandleResourceChange | ( | TInt | aType | ) | [protected, virtual] |
From CCoeControl This function is called when control resources are changed.
TInt aType | A message UID value. |
TKeyResponse | HandleScrollKeyL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [private] |
Performs scroll key event handling
const TKeyEvent & aKeyEvent | |
TEventCode aType |
TKeyResponse | HandleVolumeKeyL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [private] |
Performs volume change key event handling
const TKeyEvent & aKeyEvent | |
TEventCode aType |
void | LayoutOverlappedPresentation | ( | ) | [private] |
Sets the correct player layout, when a dialog (e.g. FindUi) is overlapping the presentation.
void | MrccatoCommand | ( | TRemConCoreApiOperationId | aOperationId, |
TRemConCoreApiButtonAction | aButtonAct | |||
) |
From MRemConCoreApiTargetObserver See remconcoreapitargetobserver.h for more information
TRemConCoreApiOperationId aOperationId | |
TRemConCoreApiButtonAction aButtonAct |
IMPORT_C CSmilPlayerDialog * | NewL | ( | CMDXMLDocument * | aDOM, |
MMediaFactoryFileInfo * | aFileInfo, | |||
const TDesC & | aBaseUrl, | |||
TBool | aPreview = EFalse, | |||
TBool | aAudioOn = EFalse | |||
) | [static] |
Two-phased constructor.
CMDXMLDocument * aDOM | Pointer to Document Object Handle. Ownership is not transferred. |
MMediaFactoryFileInfo * aFileInfo | Handle to the media objects file info. |
const TDesC & aBaseUrl | Base URL that is used for resolving relative URLs. |
TBool aPreview = EFalse | Boolean if player started to preview mode. |
TBool aAudioOn = EFalse | Boolean if presentation includes the audio. |
IMPORT_C CSmilPlayerDialog * | NewL | ( | RFile & | aFileHandle, |
MMediaFactoryFileInfo * | aFileInfo, | |||
const TDesC & | aBaseUrl, | |||
TBool | aPreview = EFalse, | |||
TBool | aAudioOn = EFalse | |||
) | [static] |
Two-phased constructor.
RFile & aFileHandle | Handle to the .smil file. Ownership is not transferred. |
MMediaFactoryFileInfo * aFileInfo | Handle to the media objects file info. |
const TDesC & aBaseUrl | Base URL that is used for resolving relative URLs. |
TBool aPreview = EFalse | Boolean if player started to preview mode. |
TBool aAudioOn = EFalse | Boolean if presentation includes the audio. |
TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [virtual] |
From CCoeControl Handles key events
const TKeyEvent & aKeyEvent | TKeyEvent |
TEventCode aType | TEventCode |
TBool | OkToExitL | ( | TInt | aButtonId | ) | [protected, virtual] |
From CEikDialog . Handles button events and checks if the dialog can be closed
TInt aButtonId | Id of the 'pressed' button |
void | PresentationStoppedL | ( | ) |
Is called from the presentationcontroller when engine indicates about the stop.
void | ProcessCommandL | ( | TInt | aCommandId | ) | [virtual] |
From MEikCommandObserver Prosesses menucommands
TInt aCommandId | Commant value defined in resources. |
void | ShowInformationNoteL | ( | TInt | aResourceID, |
TBool | aWaiting | |||
) | [private] |
Auxiliary function. Shows a information note using notewrappers.
void | ShowMenubarL | ( | TInt | aResourceId | ) | [private] |
Shows given menubar
TInt aResourceId |
void | StopTiming | ( | ) | [private] |
Stops the timers of the time indicator. Indirectly called by the callback function DoStopTiming.
void | VolumeRepeat | ( | ) | [private] |
Performs one volume repeat. Indirectly called by the callback function DoVolumeRepeat.
EPreview = 0x0001 | |
EAudioOn = 0x0002 | |
EHelpSupported = 0x0004 | |
EScrollingActivated = 0x0008 | |
EFeatureSideVolumeKeys = 0x0010 |
Presentation states of the player
ESmilPlayerStateNotReady = 0 | |
ESmilPlayerStatePlaying | |
ESmilPlayerStatePause | |
ESmilPlayerStateStop |
CRemConInterfaceSelector * | iInterfaceSelector | [private] |
CSmilPlayerPresentationController * | iPresentationController | [private] |
TSmilPlayerPresentationStates | iPresentationState | [private] |
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.