Collapse all Symbian^3 Product Developer Library

CSmilMedia Class Reference

class CSmilMedia : public CSmilTimeContainer

Inherits from

CSmilMedia
- CSmilTimeContainer
  - CSmilObject
    - CBase

Nested Classes and Structures

CSmilMedia::CNameValuePair

Public Member Functions
	~CSmilMedia()
CSmilTransitionFilter *	ActiveTransitionFilter()
void	AddParamL(const TDesC &, const TDesC &)
void	AfterL(MSmilActive *, const TSmilTime &, TBool)
TPtrC	Alt()
void	CancelActive(MSmilActive *)
TPoint	Center()
const TDesC *	ClassName()
TSmilTime	ClipBegin()
TSmilTime	ClipEnd()
void	ForceRepeat(TBool)
CSmilArea *	GetArea()
TPtrC	GetParam(const TDesC &)
TRect	GetRectangle()
MSmilRegion *	GetRegion()
MSmilMediaRenderer *	GetRenderer()
TBool	HasFocus()
TBool	IsFocusable()
TBool	IsScrollable()
TBool	IsVisible()
TSmilTime	MediaBegin()
TSmilTime	MediaEnd()
CSmilMedia *	NewL(CSmilPresentation *)
TSmilTime	PredictedRemovalTime()
CSmilPresentation *	Presentation()
void	Redraw()
void	RendererAtEndL()
void	RendererDurationChangedL()
void	SetAltL(const TDesC &)
void	SetFocus(TBool)
void	SetFocusable(TBool)
void	SetPaused(TBool)
void	SetRegion(MSmilRegion *)
void	SetSrcL(const TDesC &)
void	SetTypeL(const TDesC &)
TPtrC	Src()
void	TransitionFilterEnd(CSmilTransitionFilter *)
TPtrC	Type()
void	Unfreeze()

Protected Member Functions
	CSmilMedia()
void	BeginL(const TSmilTime &)
void	EndL(const TSmilTime &)
TSmilTime	ImplicitDuration()
TBool	IsMedia()
TBool	IsSelected()
TSmilTime	NextActivation(const TSmilTime &)
const CArrayFixFlat< TPoint > *	PolyPoints()
void	ProceedL(const TSmilTime &)
TRect	Rect()
void	RepeatL(const TSmilTime &)
void	ResolveL(const TSmilTime &)
TShape	Shape()

Private Member Functions
void	CreateRendererL(const TSmilTime &)

Inherited Functions
	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()
	CSmilObject::ActiveTime()
	CSmilObject::ActualRepeat()const
	CSmilObject::AddConditionL(const TSmilCondition &,TBool)
	CSmilObject::Anchor()const
	CSmilObject::AttachedL()
	CSmilObject::BeginSpecified()
	CSmilObject::BeginTime()const
	CSmilObject::CSmilObject()
	CSmilObject::CalcActiveEnd(TSmilTime)
	CSmilObject::CalcActiveEnd(TSmilTime,TSmilTime)
	CSmilObject::CalcIntermediateActiveDuration()const
	CSmilObject::ConstructL(CSmilPresentation *)
	CSmilObject::Duration()const
	CSmilObject::EndSpecified()
	CSmilObject::EndTime()const
	CSmilObject::Fill()const
	CSmilObject::FirstInterval()
	CSmilObject::GlobalToLocal(const TSmilTime &)
	CSmilObject::HasBeginEvent()
	CSmilObject::HasBeginTime()
	CSmilObject::HasEndEvent()
	CSmilObject::HasEndTime()
	CSmilObject::HasMoreIntervals()
	CSmilObject::Id()const
	CSmilObject::Initialise()
	CSmilObject::IsA()const
	CSmilObject::IsArea()const
	CSmilObject::IsExclusive()const
	CSmilObject::IsParallel()const
	CSmilObject::IsPlaying()const
	CSmilObject::IsPrefetch()const
	CSmilObject::IsRepeating()const
	CSmilObject::IsSequence()const
	CSmilObject::LocalToGlobal(const TSmilTime &)
	CSmilObject::Max()const
	CSmilObject::Min()const
	CSmilObject::NextAdjacent()const
	CSmilObject::NextInterval()
	CSmilObject::NextSibling()
	CSmilObject::NextSibling()const
	CSmilObject::ParentObject()
	CSmilObject::ParentSimpleEnd()
	CSmilObject::Presentation()
	CSmilObject::PreviousAdjacent()const
	CSmilObject::PreviousSibling()
	CSmilObject::PreviousSibling()const
	CSmilObject::PropagateEventL(const TSmilEvent &,const TSmilTime &)
	CSmilObject::RecalcInterval(const TSmilTime &)
	CSmilObject::RepeatBeginTime()const
	CSmilObject::RepeatCount()const
	CSmilObject::RepeatDur()const
	CSmilObject::ResolveBeginTimeL(TSmilTime)
	CSmilObject::ResolveEndTimeL(TSmilTime)
	CSmilObject::ResolveSimpleDuration()
	CSmilObject::Restart()const
	CSmilObject::RewindL(const TSmilTime &,const TSmilTime &)
	CSmilObject::SetAnchor(CSmilAnchor *)
	CSmilObject::SetDuration(const TSmilTime &)
	CSmilObject::SetEndTime(const TSmilTime &)
	CSmilObject::SetFill(TFill)
	CSmilObject::SetIdL(const TDesC &)
	CSmilObject::SetMax(const TSmilTime &)
	CSmilObject::SetMin(const TSmilTime &)
	CSmilObject::SetNextSibling(CSmilObject *)
	CSmilObject::SetParent(CSmilTimeContainer *)
	CSmilObject::SetPreviousSibling(CSmilObject *)
	CSmilObject::SetRepeatCount(TReal32)
	CSmilObject::SetRepeatDur(TSmilTime)
	CSmilObject::SetRestart(TRestart)
	CSmilObject::SetTitleL(const TDesC &)
	CSmilObject::Title()const
	CSmilObject::~CSmilObject()
	CSmilTimeContainer::AddChild(CSmilObject *)
	CSmilTimeContainer::CSmilTimeContainer()
	CSmilTimeContainer::FindNamedObject(const TDesC &)
	CSmilTimeContainer::FirstChild()const
	CSmilTimeContainer::IsTimeContainer()const
	CSmilTimeContainer::LastChild()const
	CSmilTimeContainer::NotifyDependents(const TSmilTime &)
	CSmilTimeContainer::PrintTree(int)const
	CSmilTimeContainer::Reset()
	CSmilTimeContainer::ResetChildrenL(const TSmilTime &)
	CSmilTimeContainer::ResolveL()
	CSmilTimeContainer::SetEndsyncL(TEndsync,const TDesC &)
	CSmilTimeContainer::TimeContainerEnd()const
	CSmilTimeContainer::~CSmilTimeContainer()

Public Attributes
TSmilTime	iClipBegin
TSmilTime	iClipEnd
RPointerArray< CNameValuePair >	iParams
CSmilTransition *	iTransitionIn
CSmilTransition *	iTransitionOut

Protected Attributes
RSmilTextBuf	iAlt
TBool	iFocus
TBool	iFocusable
RSmilTextBuf	iSrc
RSmilTextBuf	iType

Private Attributes
MSmilRegion *	iRegion
MSmilMediaRenderer *	iRenderer
CSmilTransitionFilter *	iTransitionFilter

Inherited Attributes
	CSmilObject::iActiveDuration
	CSmilObject::iActualRepeat
	CSmilObject::iAnchor
	CSmilObject::iBeginConditions
	CSmilObject::iBeginList
	CSmilObject::iCurrentInterval
	CSmilObject::iDuration
	CSmilObject::iEndConditions
	CSmilObject::iEndList
	CSmilObject::iFill
	CSmilObject::iFirstInterval
	CSmilObject::iForcedRepeat
	CSmilObject::iId
	CSmilObject::iMax
	CSmilObject::iMin
	CSmilObject::iMinLimited
	CSmilObject::iNext
	CSmilObject::iParentObject
	CSmilObject::iPlaying
	CSmilObject::iPresentation
	CSmilObject::iPrevious
	CSmilObject::iRepeatBeginTime
	CSmilObject::iRepeatCount
	CSmilObject::iRepeatDur
	CSmilObject::iRestart
	CSmilObject::iSimpleDuration
	CSmilObject::iTitle
	CSmilTimeContainer::iEndsync
	CSmilTimeContainer::iEndsyncId
	CSmilTimeContainer::iFirstChild
	CSmilTimeContainer::iLastChild

Constructor & Destructor Documentation

CSmilMedia()

CSmilMedia

(

)

[protected]

~CSmilMedia()

~CSmilMedia

(

)

[virtual]

Member Functions Documentation

ActiveTransitionFilter()

CSmilTransitionFilter *

ActiveTransitionFilter

(

)

const

AddParamL(const TDesC &, const TDesC &)

void	AddParamL	(	const TDesC &	aName,
			const TDesC &	aValue
		)

Parameters

const TDesC & aName
const TDesC & aValue

AfterL(MSmilActive *, const TSmilTime &, TBool)

void	AfterL	(	MSmilActive *	iActive,
			const TSmilTime &	aDelay,
			TBool	aLazy = EFalse
		)

Parameters

MSmilActive * iActive
const TSmilTime & aDelay
TBool aLazy = EFalse

Alt()

TPtrC

Alt

(

)

const [inline]

BeginL(const TSmilTime &)

void

BeginL

(

const TSmilTime &

aTime

)

[protected, virtual]

Begin an object & generate a begin event.

Parameters

const TSmilTime & aTime

CancelActive(MSmilActive *)

void

CancelActive

(

MSmilActive *

aActive

)

Parameters

MSmilActive * aActive

Center()

TPoint

Center

(

)

const [inline, virtual]

ClassName()

const TDesC *

ClassName

(

)

const [inline, virtual]

ClipBegin()

TSmilTime

ClipBegin

(

)

[inline]

ClipEnd()

TSmilTime

ClipEnd

(

)

[inline]

CreateRendererL(const TSmilTime &)

void

CreateRendererL

(

const TSmilTime &

aRecalcTime

)

[private]

Parameters

const TSmilTime & aRecalcTime

EndL(const TSmilTime &)

void

EndL

(

const TSmilTime &

aTime

)

[protected, virtual]

End an object & geberate an end event.

Parameters

const TSmilTime & aTime

ForceRepeat(TBool)

void

ForceRepeat

(

TBool

aBool

)

Parameters

TBool aBool

GetArea()

CSmilArea *

GetArea

(

)

GetParam(const TDesC &)

TPtrC

GetParam

(

const TDesC &

aName

)

const

Get name media parameter, or empty TPtrC if not found

Parameters

const TDesC & aName

GetRectangle()

TRect

GetRectangle

(

)

const

Returns the rectangle (region) where the media is supposed to be rendered on.

GetRegion()

MSmilRegion *

GetRegion

(

)

const [virtual]

Returns the region where this media is supposed to be rendered on. May be NULL.

GetRenderer()

MSmilMediaRenderer *

GetRenderer

(

)

const [inline]

HasFocus()

TBool

HasFocus

(

)

const [inline, virtual]

ImplicitDuration()

TSmilTime

ImplicitDuration

(

)

const [protected, virtual]

Get the implicit duration of an object.

IsFocusable()

TBool

IsFocusable

(

)

const [virtual]

IsMedia()

TBool

IsMedia

(

)

const [protected, inline, virtual]

IsScrollable()

TBool

IsScrollable

(

)

const [virtual]

IsSelected()

TBool

IsSelected

(

)

const [protected]

IsVisible()

TBool

IsVisible

(

)

const [virtual]

MediaBegin()

TSmilTime

MediaBegin

(

)

const

Returns begin time of media relative to presentation begin time.

MediaEnd()

TSmilTime

MediaEnd

(

)

const

Returns end time of media relative to presentation begin time.

NewL(CSmilPresentation *)

CSmilMedia *

NewL

(

CSmilPresentation *

aPresentation

)

[static]

Parameters

CSmilPresentation * aPresentation

NextActivation(const TSmilTime &)

TSmilTime

NextActivation

(

const TSmilTime &

aTime

)

const [protected, virtual]

Parameters

const TSmilTime & aTime

PolyPoints()

const CArrayFixFlat< TPoint > *

PolyPoints

(

)

const [protected, inline]

PredictedRemovalTime()

TSmilTime

PredictedRemovalTime

(

)

const

Presentation()

CSmilPresentation *

Presentation

(

)

const

Presentation

ProceedL(const TSmilTime &)

void

ProceedL

(

const TSmilTime &

aTps

)

[protected, virtual]

A common "proceed" function for all timed objects. Called each time a timed object receives the timing signal.

Parameters

const TSmilTime & aTps

Rect()

TRect

Rect

(

)

const [protected, inline]

Redraw()

void

Redraw

(

)

[virtual]

Invoked by renderer to ask redrawing of area covered by the media. This should be invoked when (visual) media appears, there are changes to it, and when it is removed.

RendererAtEndL()

void

RendererAtEndL

(

)

Invoked by a MSmillMediaRenderer object when the associated media ends (end of the file or stream is reached). Renderer should also move to frozen state at this point (that is, to keep showing the last frame).

RendererDurationChangedL()

void

RendererDurationChangedL

(

)

Invoked by a MSmillMediaRenderer object when there is a change in (known) state of its intrinsic values. For example, duration of video clip is not typically known until it is at least partially decoded. This method should be invoked by the renderer when this information becomes available.

RepeatL(const TSmilTime &)

void

RepeatL

(

const TSmilTime &

aTime

)

[protected, virtual]

Repeat an object.

Parameters

const TSmilTime & aTime

ResolveL(const TSmilTime &)

void

ResolveL

(

const TSmilTime &

aTps

)

[protected, virtual]

Parameters

const TSmilTime & aTps

SetAltL(const TDesC &)

void

SetAltL

(

const TDesC &

aPtr

)

Parameters

const TDesC & aPtr

SetFocus(TBool)

void

SetFocus

(

TBool

aFocus

)

[inline, virtual]

Parameters

TBool aFocus

SetFocusable(TBool)

void

SetFocusable

(

TBool

aFocusable

)

[inline, virtual]

Parameters

TBool aFocusable

SetPaused(TBool)

void

SetPaused

(

TBool

aPaused

)

[virtual]

Parameters

TBool aPaused

SetRegion(MSmilRegion *)

void

SetRegion

(

MSmilRegion *

aRegion

)

[inline]

Parameters

MSmilRegion * aRegion

SetSrcL(const TDesC &)

void

SetSrcL

(

const TDesC &

aString

)

Parameters

const TDesC & aString

SetTypeL(const TDesC &)

void

SetTypeL

(

const TDesC &

aString

)

Parameters

const TDesC & aString

Shape()

TShape

Shape

(

)

const [protected, inline]

Src()

TPtrC

Src

(

)

const [inline]

TransitionFilterEnd(CSmilTransitionFilter *)

void

TransitionFilterEnd

(

CSmilTransitionFilter *

)

Parameters

CSmilTransitionFilter *

Type()

TPtrC

Type

(

)

const [inline]

Unfreeze()

void

Unfreeze

(

)

[virtual]

Unfreeze an object.

Member Data Documentation

RSmilTextBuf iAlt

RSmilTextBuf

iAlt

[protected]

TSmilTime iClipBegin

TSmilTime

iClipBegin

TSmilTime iClipEnd

TSmilTime

iClipEnd

TBool iFocus

TBool

iFocus

[protected]

TBool iFocusable

TBool

iFocusable

[protected]

RPointerArray< CNameValuePair > iParams

RPointerArray< CNameValuePair >

iParams

MSmilRegion * iRegion

MSmilRegion *

iRegion

[private]

MSmilMediaRenderer * iRenderer

MSmilMediaRenderer *

iRenderer

[private]

RSmilTextBuf iSrc

RSmilTextBuf

iSrc

[protected]

CSmilTransitionFilter * iTransitionFilter

CSmilTransitionFilter *

iTransitionFilter

[private]

CSmilTransition * iTransitionIn

CSmilTransition *

iTransitionIn

CSmilTransition * iTransitionOut

CSmilTransition *

iTransitionOut

RSmilTextBuf iType

RSmilTextBuf

iType

[protected]