CSmilPlayerDialog Class Reference

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.

smilplayer.lib
Since
2.0
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 ()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CAknDialog::CAknDialog()
CAknDialog::ConstructL(TInt)
CAknDialog::CreateMenuBarL(TInt)
CAknDialog::DisplayMenuL()
CAknDialog::Draw(const TRect &)const
CAknDialog::ExecuteLD(TInt)
CAknDialog::FocusChanged(TDrawNow)
CAknDialog::HandlePointerEventL(const TPointerEvent &)
CAknDialog::HideMenu()
CAknDialog::MenuShowing()const
CAknDialog::MopSupplyObject(TTypeUid)
CAknDialog::PrepareLC(TInt)
CAknDialog::RunLD()
CAknDialog::SetEmphasis(CCoeControl *,TBool)
CAknDialog::SizeChanged()
CAknDialog::~CAknDialog()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MaximumWidth()const
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikDialog::ActivateFirstPageL()const
CEikDialog::ActivePageId()const
CEikDialog::ActivePageIndex()const
CEikDialog::AddAutoDateEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TTime *)
CEikDialog::AddAutoDurationEditorL(const TDesC &,TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &,TBool,TTimeIntervalSeconds *)
CEikDialog::AddAutoFixedPointEditorL(const TDesC &,TInt,TInt,TInt,TInt *,TInt)
CEikDialog::AddAutoFloatEditorL(const TDesC &,TInt,const TReal &,const TReal &,TReal *)
CEikDialog::AddAutoGlobalTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TInt,CGlobalText *,TInt,TInt)
CEikDialog::AddAutoNumberEditorL(const TDesC &,TInt,TInt,TInt,TInt *)
CEikDialog::AddAutoRangeEditorL(const TDesC &,TInt,TInt,TInt,HBufC *,SEikRange *)
CEikDialog::AddAutoRichTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TInt,CGlobalText *,TInt,TInt)
CEikDialog::AddAutoSecretEditorL(const TDesC &,TInt,TDes *)
CEikDialog::AddAutoTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TDes *)
CEikDialog::AddAutoTimeAndDateEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TBool,HBufC *,TTime *)
CEikDialog::AddAutoTimeEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TTime *)
CEikDialog::AddAutoTimeOffsetEditorL(const TDesC &,TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &,TBool,TTimeIntervalSeconds *)
CEikDialog::AdjustAllIdsOnPage(TInt,TInt)
CEikDialog::BorderStyle()
CEikDialog::ButtonCommandObserver()const
CEikDialog::ButtonGroupContainer()const
CEikDialog::ComponentControl(TInt)const
CEikDialog::ConstructAutoDialogLC(TInt,TInt)
CEikDialog::ConstructSleepingAlertDialogL(TInt)
CEikDialog::ConstructSleepingDialogL(TInt)
CEikDialog::Control(TInt)const
CEikDialog::ControlCaption(TInt)const
CEikDialog::ControlOrNull(TInt)const
CEikDialog::ControlsOnPage(RArray< CEikCaptionedControl * > &,TInt)const
CEikDialog::ConvertCustomControlTypeToBaseControlType(TInt)const
CEikDialog::CountComponentControls()const
CEikDialog::CreateCustomControlL(TInt)
CEikDialog::CreateLineByTypeL(const TDesC &,TInt,TInt,TAny *)
CEikDialog::CreateLineByTypeL(const TDesC &,TInt,TInt,TInt,TAny *)
CEikDialog::CurrentLine()const
CEikDialog::DECLARE_TYPE_ID(0x10282EA8)
CEikDialog::DeclareAutoDateEditor(TInt,TTime *)
CEikDialog::DeclareAutoDurationEditor(TInt,TTimeIntervalSeconds *)
CEikDialog::DeclareAutoFixedPointEditor(TInt,TInt *)
CEikDialog::DeclareAutoNumberEditor(TInt,TInt *)
CEikDialog::DeclareAutoRangeEditor(TInt,SEikRange *)
CEikDialog::DeclareAutoSecretEditor(TInt,TDes *)
CEikDialog::DeclareAutoTextEditorL(TInt,TDes *)
CEikDialog::DeclareAutoTimeAndDateEditor(TInt,TTime *)
CEikDialog::DeclareAutoTimeEditor(TInt,TTime *)
CEikDialog::DeclareAutoTimeOffsetEditor(TInt,TTimeIntervalSeconds *)
CEikDialog::DeclareItemAuto(TInt,TInt,TAny *)
CEikDialog::DeleteLine(TInt,TBool)
CEikDialog::DialogFlags()
CEikDialog::DurationEditorValue(TInt)const
CEikDialog::ExitSleepingDialog()
CEikDialog::Extension()const
CEikDialog::FindLineIndex(const CCoeControl &)const
CEikDialog::FixedPointEditorDecimal(TInt)const
CEikDialog::FixedPointEditorValue(TInt)const
CEikDialog::FloatEditorValue(TInt)const
CEikDialog::FloatingPointEditorValue(TInt)const
CEikDialog::FormFlagsFromActivePage()
CEikDialog::GetAutoValuesFromPage(CEikCapCArray *)
CEikDialog::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CEikDialog::GetCustomAutoValue(TAny *,TInt,const CCoeControl *)
CEikDialog::GetEdwinText(TDes &,TInt)const
CEikDialog::GetFileName(TFileName *,TInt)const
CEikDialog::GetFirstLineOnFirstPageOrNull()
CEikDialog::GetLabelText(TDes &,TInt)const
CEikDialog::GetLineByLineAndPageIndex(TInt,TInt)const
CEikDialog::GetNumberOfLinesOnPage(TInt)const
CEikDialog::GetNumberOfPages()const
CEikDialog::GetSecretEditorText(TDes &,TInt)const
CEikDialog::GetTextEditorText(CGlobalText *&,TInt)
CEikDialog::HandleControlEventL(CCoeControl *,TCoeEvent)
CEikDialog::HandleControlStateChangeL(TInt)
CEikDialog::HandleDialogPageEventL(TInt)
CEikDialog::HandleInteractionRefused(TInt)
CEikDialog::IdOfFocusControl()const
CEikDialog::InputCapabilities()const
CEikDialog::InsertLineL(TInt,TInt,TInt)
CEikDialog::IsEditable()const
CEikDialog::Layout()
CEikDialog::Line(TInt)const
CEikDialog::LineChangedL(TInt)
CEikDialog::ListBoxCurrentItem(TInt)const
CEikDialog::MakeLineVisible(TInt,TBool)
CEikDialog::MakePanelButtonVisible(TInt,TBool)
CEikDialog::MakeVisible(TBool)
CEikDialog::MakeWholeLineVisible(TInt,TBool)
CEikDialog::MappedCommandId(TInt)
CEikDialog::NumberEditorValue(TInt)const
CEikDialog::PageChangedL(TInt)
CEikDialog::PostLayoutDynInitL()
CEikDialog::PreLayoutDynInitL()
CEikDialog::PreferredSize(const TSize &)const
CEikDialog::PrepareContext(CWindowGc &)const
CEikDialog::PrepareForFocusTransitionL()
CEikDialog::PublishDialogL(TInt,TUid)
CEikDialog::RangeEditorValue(TInt)const
CEikDialog::ReadResourceLC(TInt)
CEikDialog::RegisterDialgWithPageSelector()
CEikDialog::ResetLineMinimumSizes()
CEikDialog::ResetSecretEditor(TInt)
CEikDialog::RotateFocusByL(TInt)
CEikDialog::RouseSleepingDialog()
CEikDialog::SetControlCaptionL(TInt,TInt)
CEikDialog::SetControlCaptionL(TInt,const TDesC &)
CEikDialog::SetDurationEditorMinAndMax(TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &)
CEikDialog::SetDurationEditorValue(TInt,const TTimeIntervalSeconds &)
CEikDialog::SetEditableL(TBool)
CEikDialog::SetEdwinTextL(TInt,const TDesC *)
CEikDialog::SetFileNameL(TInt,const TDesC *)
CEikDialog::SetFixedPointEditorDecimal(TInt,TInt)
CEikDialog::SetFixedPointEditorValueL(TInt,TInt)
CEikDialog::SetFloatEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetFloatEditorValueL(TInt,TReal)
CEikDialog::SetFloatingPointEditorValueL(TInt,const TReal *)
CEikDialog::SetInitialCurrentLine()
CEikDialog::SetLabelL(TInt,TInt)
CEikDialog::SetLabelL(TInt,const TDesC &)
CEikDialog::SetLabelReserveLengthL(TInt,TInt)
CEikDialog::SetLineDimmedNow(TInt,TBool)
CEikDialog::SetLineNonFocusing(TInt)
CEikDialog::SetListBoxCurrentItem(TInt,TInt)
CEikDialog::SetMediatorObserver(MAknDialogMediatorObserver *)
CEikDialog::SetMultilineQuery(TBool)
CEikDialog::SetNumberEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetNumberEditorValue(TInt,TInt)
CEikDialog::SetPageDensePacking(TInt,TBool)
CEikDialog::SetPageDimmedNow(TInt,TBool)
CEikDialog::SetRangeEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetRangeEditorValue(TInt,const SEikRange &)
CEikDialog::SetSizeAndPosition(const TSize &)
CEikDialog::SetTTimeEditorMinAndMax(TInt,const TTime &,const TTime &)
CEikDialog::SetTTimeEditorValue(TInt,const TTime &)
CEikDialog::SetTextEditorTextL(TInt,const CGlobalText *)
CEikDialog::SetTimeOffsetEditorMinAndMax(TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &)
CEikDialog::SetTimeOffsetEditorValue(TInt,const TTimeIntervalSeconds &)
CEikDialog::SetTitleL(TInt)
CEikDialog::SetTitleL(const TDesC &)
CEikDialog::SlideDialog()
CEikDialog::SwapButtonGroupContainer(CEikButtonGroupContainer *)
CEikDialog::SwitchLineLatency(TInt,TInt)
CEikDialog::TTimeEditorValue(TInt)const
CEikDialog::TimeOffsetEditorValue(TInt)const
CEikDialog::Title()const
CEikDialog::TryChangeFocusToL(TInt)
CEikDialog::TryExitL(TInt)
CEikDialog::UpdatePageL(TBool)
CEikDialog::WriteInternalStateL(RWriteStream &)const
CEikDialog::~CEikDialog()
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

Constructor & Destructor Documentation

CSmilPlayerDialog()

CSmilPlayerDialog ( ) [private]

Default C++ constructor.

CSmilPlayerDialog(TBool, TBool)

CSmilPlayerDialog ( TBool aPreview,
TBool aAudioOn
) [private]

C++ constructor.

Parameters

TBool aPreview
TBool aAudioOn

~CSmilPlayerDialog()

~CSmilPlayerDialog ( ) [virtual]

Destructor.

Member Functions Documentation

ActivateL()

void ActivateL ( ) [private, virtual]

Called just before Draw function

ActivateScrollingL()

void ActivateScrollingL ( ) [private]

Activates scrolling.

AudioEnabled()

TBool AudioEnabled ( ) const [private]

Returns whether audio is enabled or not.

ChangeStateL(TSmilPlayerPresentationStates)

void ChangeStateL ( TSmilPlayerPresentationStates aState ) [private]

Changes the state of the player to given one.

Parameters

TSmilPlayerPresentationStates aState New state

ClosePlayer()

void ClosePlayer ( ) [private]

Exits the player. Indirectly called by the callback function DoCloseTiming.

CommonConstructL()

void CommonConstructL ( ) [private]

Common 2nd phase constructor shared by two overloaded ConstructL functions.

ConstructL(const TDesC &, MMediaFactoryFileInfo *, CMDXMLDocument *)

void ConstructL ( const TDesC & aBaseUrl,
MMediaFactoryFileInfo * aFileInfo,
CMDXMLDocument * aDOM
) [private]

Symbian 2nd phase constructor.

Parameters

const TDesC & aBaseUrl
MMediaFactoryFileInfo * aFileInfo
CMDXMLDocument * aDOM

ConstructL(const TDesC &, MMediaFactoryFileInfo *, RFile &)

void ConstructL ( const TDesC & aBaseUrl,
MMediaFactoryFileInfo * aFileInfo,
RFile & aFileHandle
) [private]

Symbian 2nd phase constructor.

Parameters

const TDesC & aBaseUrl
MMediaFactoryFileInfo * aFileInfo
RFile & aFileHandle

DeactivateScrollingL()

void DeactivateScrollingL ( )

Deactivates scrolling.

DoClosePlayer(TAny *)

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.

Parameters

TAny * aObject

DoFindItemL(TInt)

void DoFindItemL ( TInt aCommandId ) [private]

Implements the find item command. Activates the find item common component.

Parameters

TInt aCommandId

DoReplayL()

void DoReplayL ( ) [private]

Performs replay functionality.

DoStopTiming(TAny *)

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.

Parameters

TAny * aObject

DoVolumeRepeat(TAny *)

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.

Parameters

TAny * aObject

DynInitMenuOptionsAtNormalEnd(CEikMenuPane *)

void DynInitMenuOptionsAtNormalEnd ( CEikMenuPane * aMenuPane ) [protected]

DynInitMenuOptionsAtNormalEnd Initializes items on the menu

Since
2.0

Parameters

CEikMenuPane * aMenuPane Pointer to menupane

DynInitMenuOptionsL(CEikMenuPane *)

void DynInitMenuOptionsL ( CEikMenuPane * aMenuPane ) [protected]

DynInitMenuOptionsL Initializes items on the menu

Since
2.0

Parameters

CEikMenuPane * aMenuPane Pointer to menupane

DynInitMenuPaneL(TInt, CEikMenuPane *)

void DynInitMenuPaneL ( TInt aMenuId,
CEikMenuPane * aMenuPane
) [protected, virtual]

From MEikMenuObserver Initializes items on the menu

Since
2.0

Parameters

TInt aMenuId Current menu's resource Id
CEikMenuPane * aMenuPane Pointer to menupane

ExecuteLD()

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

Since
2.0

GetHelpContext(TCoeHelpContext &)

void GetHelpContext ( TCoeHelpContext & aContext ) const [protected, virtual]

From CCoeControl This function is called when Help application is launched.

Since
2.0

Parameters

TCoeHelpContext & aContext Help context

HandleGainingForeground()

void HandleGainingForeground ( )

From MCoeForegroundObserver Prosesses foreground event.

Since
2.0

HandleKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse HandleKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [private]

Performs key event handling

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

HandleLosingForeground()

void HandleLosingForeground ( )

From MCoeForegroundObserver Prosesses foreground event.

Since
2.0

HandleResourceChange(TInt)

void HandleResourceChange ( TInt aType ) [protected, virtual]

From CCoeControl This function is called when control resources are changed.

Since
2.0

Parameters

TInt aType A message UID value.

HandleScrollKeyL(const TKeyEvent &, TEventCode)

TKeyResponse HandleScrollKeyL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [private]

Performs scroll key event handling

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

HandleSelectionKeyL()

TKeyResponse HandleSelectionKeyL ( )

Performs selection key event handling

HandleVolumeKeyL(const TKeyEvent &, TEventCode)

TKeyResponse HandleVolumeKeyL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [private]

Performs volume change key event handling

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

LaunchHelpL()

void LaunchHelpL ( ) const [private]

Launches help application

LayoutOverlappedPresentation()

void LayoutOverlappedPresentation ( ) [private]

Sets the correct player layout, when a dialog (e.g. FindUi) is overlapping the presentation.

LayoutPresentationL()

void LayoutPresentationL ( ) [private]

Sets the correct layout.

MrccatoCommand(TRemConCoreApiOperationId, TRemConCoreApiButtonAction)

void MrccatoCommand ( TRemConCoreApiOperationId aOperationId,
TRemConCoreApiButtonAction aButtonAct
)

From MRemConCoreApiTargetObserver See remconcoreapitargetobserver.h for more information

Since
3.0

NewL(CMDXMLDocument *, MMediaFactoryFileInfo *, const TDesC &, TBool, TBool)

IMPORT_C CSmilPlayerDialog * NewL ( CMDXMLDocument * aDOM,
MMediaFactoryFileInfo * aFileInfo,
const TDesC & aBaseUrl,
TBool aPreview = EFalse,
TBool aAudioOn = EFalse
) [static]

Two-phased constructor.

Parameters

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.

NewL(RFile &, MMediaFactoryFileInfo *, const TDesC &, TBool, TBool)

IMPORT_C CSmilPlayerDialog * NewL ( RFile & aFileHandle,
MMediaFactoryFileInfo * aFileInfo,
const TDesC & aBaseUrl,
TBool aPreview = EFalse,
TBool aAudioOn = EFalse
) [static]

Two-phased constructor.

Parameters

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.

OfferKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [virtual]

From CCoeControl Handles key events

Since
2.0

Parameters

const TKeyEvent & aKeyEvent TKeyEvent
TEventCode aType TEventCode

OkToExitL(TInt)

TBool OkToExitL ( TInt aButtonId ) [protected, virtual]

From CEikDialog . Handles button events and checks if the dialog can be closed

Since
2.0

Parameters

TInt aButtonId Id of the 'pressed' button

PauseTappedL()

void PauseTappedL ( )

The function is used to pause the presentation

PlayTappedL()

void PlayTappedL ( )

The function is used to start/continue playing the presentation

PresentationRect()

TRect PresentationRect ( ) const [private]

Returns presentation rectangle.

PresentationStoppedL()

void PresentationStoppedL ( )

Is called from the presentationcontroller when engine indicates about the stop.

Since
2.0

ProcessCommandL(TInt)

void ProcessCommandL ( TInt aCommandId ) [virtual]

From MEikCommandObserver Prosesses menucommands

Since
2.0

Parameters

TInt aCommandId Commant value defined in resources.

ShowInformationNoteL(TInt, TBool)

void ShowInformationNoteL ( TInt aResourceID,
TBool aWaiting
) [private]

Auxiliary function. Shows a information note using notewrappers.

Parameters

TInt aResourceID
TBool aWaiting

ShowMenubarL(TInt)

void ShowMenubarL ( TInt aResourceId ) [private]

Shows given menubar

Parameters

TInt aResourceId

StopTiming()

void StopTiming ( ) [private]

Stops the timers of the time indicator. Indirectly called by the callback function DoStopTiming.

VolumeRepeat()

void VolumeRepeat ( ) [private]

Performs one volume repeat. Indirectly called by the callback function DoVolumeRepeat.

Member Enumerations Documentation

Enum TSmilPlayerFlags

Enumerators

EPreview = 0x0001
EAudioOn = 0x0002
EHelpSupported = 0x0004
EScrollingActivated = 0x0008
EFeatureSideVolumeKeys = 0x0010

Enum TSmilPlayerPresentationStates

Presentation states of the player

Enumerators

ESmilPlayerStateNotReady = 0
ESmilPlayerStatePlaying
ESmilPlayerStatePause
ESmilPlayerStateStop

Member Data Documentation

CRemConCoreApiTarget * iCoreTarget

CRemConCoreApiTarget * iCoreTarget [private]

CFindItemMenu * iFindItemMenu

CFindItemMenu * iFindItemMenu [private]

CRemConInterfaceSelector * iInterfaceSelector

CRemConInterfaceSelector * iInterfaceSelector [private]

TInt iPlayerFlags

TInt iPlayerFlags [private]

CSmilPlayerPresentationController * iPresentationController

CSmilPlayerPresentationController * iPresentationController [private]

TSmilPlayerPresentationStates iPresentationState

TSmilPlayerPresentationStates iPresentationState [private]

CPeriodic * iRCSTimer

CPeriodic * iRCSTimer [private]

TRemConCoreApiOperationId iRepeatId

TRemConCoreApiOperationId iRepeatId [private]

RConeResourceLoader iResLoader

RConeResourceLoader iResLoader [private]

CPeriodic * iTimer

CPeriodic * iTimer [private]