Interface ISyncMediaSegment

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

interface ISyncMediaSegment {
    getApproximateDurationMs(): number;
    getDurationType(): SyncMediaSegmentDurationType;
    getMediaObjectRefs(): ISyncMediaObjectRef[];
    getReaderDocumentIndexInSpine(): number;
    toJSON(): ISyncMediaSegmentData;
}

Methods

getApproximateDurationMs

getApproximateDurationMs(): number
Gets the duration of a segment. It is possible that this duration is updated during runtime as media is loaded and more information is available. If that happens, a syncMediaSegmentDurationChanged engine event will fire.

Returns number

getDurationType

getDurationType(): SyncMediaSegmentDurationType
Gets the duration type of the segment.

Returns SyncMediaSegmentDurationType

getMediaObjectRefs

getMediaObjectRefs(): ISyncMediaObjectRef[]
Media object references part of this segment.

Returns ISyncMediaObjectRef[]

getReaderDocumentIndexInSpine

getReaderDocumentIndexInSpine(): number
Get the index in spine of the reader document the segment is associated with.

Returns number

toJSON

toJSON(): ISyncMediaSegmentData
Get this instance as a plain JSON serializable object.

Returns ISyncMediaSegmentData