ISyncMediaTtsContentBlockRendererOptions | Colibrio Reader Framework API

Options for a SyncMediaTtsContentBlockRenderer.

Hierarchy

ISyncMediaTtsContentBlockRendererOptions

Index

Properties

Optional highlightFirstWordOnSegmentActive

highlightFirstWordOnSegmentActive?: boolean

If set to false, words will only be highlighted while the TTS is playing and word boundary events are being sent from the synthesizer. This means that when seeking while paused, no words will be highlighted.

Is set to true, the first word is highlighted immediately when a segment becomes active. Note that if the speech synthesizer and/or the voice used does not support word boundary events, the first word will remain highlighted until another segment becomes active.

This option is only applicable when wordHighlightEnabled is set to true.

default: false

Optional segmentHighlightAnnotationOptions

segmentHighlightAnnotationOptions?: IReaderViewAnnotationOptions

ReaderViewAnnotationOptions to use for segment highlighting. If null, the options set with ReaderViewAnnotationLayer.setDefaultAnnotationOptions() will be used.

default: null

Optional segmentHighlightEnabled

segmentHighlightEnabled?: boolean

If the active segment should be highlighted.

default: true

Optional wordHighlightAnnotationOptions

wordHighlightAnnotationOptions?: IReaderViewAnnotationOptions

ReaderViewAnnotationOptions to use for word highlighting. If null, the options set with ReaderViewAnnotationLayer.setDefaultAnnotationOptions() will be used.

default: null

Optional wordHighlightEnabled

wordHighlightEnabled?: boolean

If the currently spoken word should be highlighted.

Note that if the speech synthesizer and/or the voice used does not support word boundary events, word highlighting will not work.

default: false