Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

approximateElapsedTimeMs

approximateElapsedTimeMs: number

The approximate elapsed time from timeline start in milliseconds

int

cancelable

cancelable: boolean

IF this event's default action is cancelable. See respective engine event for its definition of default action.

nativeignore

defaultPrevented

defaultPrevented: boolean

If this event's default action has been canceled/prevented by a call to preventDefault()

nativeignore

immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

nativeignore

isTrusted

isTrusted: boolean

If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

nativeignore

objectType

The type of engine event object this JSON structure represents.

default

SYNC_MEDIA_SEGMENT_ACTIVE_ENGINE_EVENT

propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

nativeignore

readerViewName

readerViewName: string

The name of the ReaderView this event is related to, if any.

nativeignore

segmentIndex

segmentIndex: number

The index in the timeline of the current active SyncMediaSegment.

int

syncMediaPlayerName

syncMediaPlayerName: string
nativeignore

syncMediaTimelinePosition

syncMediaTimelinePosition: ISyncMediaTimelinePositionData

The current player timeline position.

targets

The targets related with the segment, such as the DOM node being spoken by TTS, or active element when playing media overlays.

The number of targets and their types are format specific.

EPUB Media Overlays reports two targets. One with type "application/smil+xml" containing the "par" node backing this segment (including references to parent "seq" nodes). One with type "application/xhtml+xml" containing the html node targeted by the "par" node.

Each node contains a start and end SyncMediaTimelinePosition. If you for example want to allow user's to skip content such as "table" elements, you can search for nodes with nodeName == "table" and skip to that node's endPosition.

type

The type of event.

Generated using TypeDoc