Options
All
  • Public
  • Public/Protected
  • All
Menu

Used for the engine event "syncMediaSegmentActive"

Hierarchy

Index

Properties

Readonly approximateElapsedTimeMs

approximateElapsedTimeMs: number

The approximate elapsed time from timeline start in milliseconds

Readonly cancelable

cancelable: boolean

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

Readonly defaultPrevented

defaultPrevented: boolean

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

Readonly immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

Readonly 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".

Readonly propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

Readonly readerView

readerView: IReaderView

The ReaderView instance this event is related to, if any.

Readonly segmentIndex

segmentIndex: number

The index in the timeline of the current active SyncMediaSegment.

Readonly syncMediaPlayer

syncMediaPlayer: ISyncMediaPlayer

The media player related with this event.

Readonly 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.

Readonly timelinePosition

timelinePosition: ISyncMediaTimelinePosition

The current player timeline position.

Readonly type

The type of event.

Methods

preventDefault

  • preventDefault(): void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • stopPropagation(): void
  • Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.

    Returns void

toJSON

Generated using TypeDoc