Interface ISyncMediaTtsContentBlockRenderer

SyncMediaObjectRenderer implementation for ContentBlock based TTS.

interface ISyncMediaTtsContentBlockRenderer {
    getOptions(): DeepRequired<ISyncMediaTtsContentBlockRendererOptions>;
    getSupportedMediaObjectRefType(): string;
    getTtsHighlightLayer(): IReaderViewAnnotationLayer<any>;
    setOptions(options: ISyncMediaTtsContentBlockRendererOptions): void;
    setTtsHighlightLayer(layer: IReaderViewAnnotationLayer<any>): void;
}

Hierarchy (View Summary)

ISyncMediaObjectRenderer
- ISyncMediaTtsContentBlockRenderer

Implemented by

SyncMediaTtsContentBlockRenderer

Methods

getOptions

getOptions(): DeepRequired<ISyncMediaTtsContentBlockRendererOptions>
Get a copy of the options used by this instance.

Returns DeepRequired<ISyncMediaTtsContentBlockRendererOptions>

getSupportedMediaObjectRefType

getSupportedMediaObjectRefType(): string
Get the list of SyncMediaObjectRefTypes that this renderer supports.

Returns string
Inherited from ISyncMediaObjectRenderer.getSupportedMediaObjectRefType

getTtsHighlightLayer

getTtsHighlightLayer(): IReaderViewAnnotationLayer<any>
Get the annotation layer used for highlighting spoken text.

Returns IReaderViewAnnotationLayer<any>

setOptions

setOptions(options: ISyncMediaTtsContentBlockRendererOptions): void
Sets new options for this instance. Existing properties are preserved if they aren't defined in the passed options object. Properties explicitly set to undefined will be restored to their default values.
Parameters
- options: ISyncMediaTtsContentBlockRendererOptions
Returns void

setTtsHighlightLayer

setTtsHighlightLayer(layer: IReaderViewAnnotationLayer<any>): void
Set the annotation layer used for highlighting spoken text. Note that you need to setup the styling of the highlight annotations using IReaderViewAnnotationLayer.setDefaultAnnotationOptions() See IReaderViewAnnotationLayer for more information.

Pass null to disable highlighting.
Parameters
- layer: IReaderViewAnnotationLayer<any>
Returns void