MSvgTimedEntityInterface Class Reference
| class MSvgTimedEntityInterface |
Interface exported by all media elements. This interface class specifies the interface for implementing runtime synchronisation. This interface is inherited by media elements such as audio/animation which provide element specific processing. Since the root SVG possesses an implicit time container the document also needs to implement this interface.
SVGTEngine.lib
- Since
- S60 3.2
Member Functions Documentation
CanGenerateTick()
|
TBool
| CanGenerateTick | ( | ) | [pure virtual] |
Check if timed entity can provide timing ticks to rest of time container elements. This behavior could change dynamically. For example, if audio clip is over, the audio element can't generate ticks for others.
- Since
- S60 3.2
CanUseParentTick()
|
TBool
| CanUseParentTick | ( | ) | [pure virtual] |
Check if timed entity can use its parent's tick. Usually only the parent document should return true for this function. All other elements return false
- Since
- S60 3.2
GetChildTimeContainer()
| CSvgTimeContainer * | GetChildTimeContainer | ( | ) | [pure virtual] |
GetCnfSyncMasterStatus(TBool &)
| void | GetCnfSyncMasterStatus | ( | TBool & | aIsSyncMaster | ) | [pure virtual] |
Returns the configured sync master value(as per DOM tree) as specified in the SVG content.
- Since
- S60 3.2
Parameters
| TBool & aIsSyncMaster | Indicates whether the element is configured as Sync Master. |
GetCurSyncMasterStatus(TBool &)
| void | GetCurSyncMasterStatus | ( | TBool & | isSyncMaster | ) | [pure virtual] |
Check if timed entity is going to act as timing master in the time container. This behavior could change dynamically.
- Since
- S60 3.2
GetEntityCurrentTime(TUint32 &)
| void | GetEntityCurrentTime | ( | TUint32 & | aEntityCurTime | ) | [pure virtual] |
When the timed entity acts as timing master in the time container, the time container gets the timed entity clock using this method and feeds to rest of timed entities.
- Since
- S60 3.2
Parameters
| TUint32 & aEntityCurTime | Current Entity Time in msecs. |
GetEntitySyncBehavior()
Returns the sync behavior of the entity.
- Since
- S60 3.2
ParentTimeContainerTick(TSvgTick)
| void | ParentTimeContainerTick | ( | TSvgTick | aTick | ) | [pure virtual] |
The parent time container provides the timing clock to the timed entity (audio, video, animation, document) using this routine.
- Since
- S60 3.2
PauseTimedEntity()
| void | PauseTimedEntity | ( | ) | [pure virtual] |
This would be used for pausing the locked timed entity while other locked timed entities get loaded.
- Since
- S60 3.2
ResumeTimedEntity()
| void | ResumeTimedEntity | ( | ) | [pure virtual] |
This would be used for resuming the locked timed entity once all locked timed entities get loaded.
- Since
- S60 3.2
ResyncTimedEntity(TUint32)
| void | ResyncTimedEntity | ( | TUint32 | aSynctime | ) | [pure virtual] |
If the timed entity needs to be in sync with the time container and it has slipped beyond the sync tolerance limit, the method is called to bring the element in sync with the time container.
- Since
- S60 3.2
Parameters
| TUint32 aSynctime | Time for resync in msecs. |
SetCurSyncMasterStatus(TBool)
| void | SetCurSyncMasterStatus | ( | TBool | aSyncMasterStatus | ) | [pure virtual] |
If some other element is resolved as syncMaster in the time container group, this element can not act as sync master.
- Since
- S60 3.2
Parameters
| TBool aSyncMasterStatus | Indicates whether the element is currrently Sync Master. |
StopTimedEntity()
| void | StopTimedEntity | ( | ) | [pure virtual] |
This would be used for stopping the timed entity.
- Since
- S60 3.2
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.