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

SyncMediaSegmentData

data class SyncMediaSegmentData(val approximateDurationMs: Int, val durationType: SyncMediaSegmentDurationType, val readerDocumentIndexInSpine: Int, val refs: List<SyncMediaObjectRef>)

Represents a segment within a SyncMediaTimeline, containing information about all SyncMediaObjectRefs that will be played in parallel.

Constructors

fun SyncMediaSegmentData(approximateDurationMs: Int, durationType: SyncMediaSegmentDurationType, readerDocumentIndexInSpine: Int, refs: List<SyncMediaObjectRef>)

Types

Companion

object Companion

Functions

serialize

fun serialize(generator: JsonGenerator)

Properties

approximateDurationMs

val approximateDurationMs: Int

The approximate duration of this segment. It is possible that the duration is updated during runtime as media is loaded and more information is available. If that happens, a syncMediaSegmentDurationChanged engine event will fire.

durationType

val durationType: SyncMediaSegmentDurationType

The duration type of this segment. If UNKNOWN the approximateDurationMs is set to 0

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int

The index in spine of the reader document the segment is associated with.

refs

val refs: List<SyncMediaObjectRef>

The SyncMediaObjectRefs that belong to this segment.