Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ISyncMediaTtsTimelineBuilderOptions

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

    interface ISyncMediaTtsTimelineBuilderOptions {
        contentTransformationOptions?: ISyncMediaTtsTimelineContentTransformationOptions;
        defaultTtsHighlightLayer?: IReaderViewAnnotationLayer;
        defaultTtsRendererOptions?: ISyncMediaTtsContentBlockRendererOptions;
        defaultTtsSynthesizer?: ITtsSynthesizer;
        name?: string;
    }

    Properties

    contentTransformationOptions?: ISyncMediaTtsTimelineContentTransformationOptions

    Options related to how TTS content is generated.

    defaultTtsHighlightLayer?: IReaderViewAnnotationLayer

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

    defaultTtsRendererOptions?: ISyncMediaTtsContentBlockRendererOptions

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

    defaultTtsSynthesizer?: ITtsSynthesizer

    The TTS Synthesizer 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.

    Properties