colibrio-reader-framework/com.colibrio.readingsystem.base/SyncMediaSegmentTargetData

SyncMediaSegmentTargetData

class SyncMediaSegmentTargetData(val frameworkComponent: EngineEventTargetFrameworkComponent, val locator: SimpleLocatorData?, val mediaType: String, val nodeData: SyncMediaEngineEventTargetXmlElementNodeData?, val objectType: EngineEventTargetObjectType = EngineEventTargetObjectType.SYNC_MEDIA_SEGMENT_TARGET, val readerDocumentIndexInSpine: Int?) : EngineEventTargetData

A target related with a SyncMediaSegment, such as the DOM node being spoken by TTS, or active element when playing media overlays.

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.

Constructors

SyncMediaSegmentTargetData

constructor(frameworkComponent: EngineEventTargetFrameworkComponent, locator: SimpleLocatorData?, mediaType: String, nodeData: SyncMediaEngineEventTargetXmlElementNodeData?, objectType: EngineEventTargetObjectType = EngineEventTargetObjectType.SYNC_MEDIA_SEGMENT_TARGET, readerDocumentIndexInSpine: Int?)

Types

Companion

object Companion

Properties

frameworkComponent

val frameworkComponent: EngineEventTargetFrameworkComponent

Describes the framework component that was the target of the event.

locator

val locator: SimpleLocatorData?

A locator that points to the publication content related with the event.

mediaType

val mediaType: String

Describes the media type of the document related with the event, and thereby what data types to expect in nodeData

nodeData

val nodeData: EngineEventTargetXmlElementNodeData?

A JSON compatible data structure representing the underlying node that was the target of the event, like for example a HTML node in a HTML content-document.

objectType

val objectType: EngineEventTargetObjectType

The type of EngineEventTarget object this JSON structure represents.

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int?

The index of the reader document that was the target of the event if any.

Functions

serialize

open override fun serialize(generator: JsonGenerator)