Interface IEpubMediaOverlaySyncMediaTimelineOptions

Options used with EpubReaderPublication.createMediaOverlaySyncMediaTimeline()

interface IEpubMediaOverlaySyncMediaTimelineOptions {
defaultAudioRendererOptions?: ISyncMediaAudioRendererOptions;
name?: string;
}

Properties

The ISyncMediaAudioRendererOptions to use for calls to timeline.createDefaultMediaObjectRenderers().

name?: string

The name to use for the timeline.

The name is used by the framework when emitting syncMediaTimelineCreateProgress events to refer to which timeline the event is related to.

If the name is left empty, the framework will generate a name for the timeline.