ISyncMediaTtsTimelineBuilderOptions | Colibrio Reader Framework API

Options used when creating a TTS SyncMediaTimeline. See EpubReaderPublication.createTtsSyncMediaTimeline and PdfReaderPublication.createTtsSyncMediaTimeline

Hierarchy

ISyncMediaTtsTimelineBuilderOptions

Index

Properties

Optional contentTransformationOptions

contentTransformationOptions?: ISyncMediaTtsTimelineContentTransformationOptions

Options related to how TTS content is generated.

Optional defaultTtsHighlightLayer

defaultTtsHighlightLayer?: IReaderViewAnnotationLayer<any>

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

Optional defaultTtsRendererOptions

defaultTtsRendererOptions?: ISyncMediaTtsContentBlockRendererOptions

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

Optional defaultTtsSynthesizer

defaultTtsSynthesizer?: ITtsSynthesizer

The TTS Synthesizer to use for calls to timeline.createDefaultMediaObjectRenderers().

Optional name

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.

nodefault