Interface ISyncMediaTtsContentBlockRenderer

SyncMediaObjectRenderer implementation for ContentBlock based TTS.

Hierarchy

ISyncMediaObjectRenderer
- ISyncMediaTtsContentBlockRenderer

Implemented by

SyncMediaTtsContentBlockRenderer

Index

Methods

Methods

createRuntime

createRuntime(timeline: ISyncMediaTimeline, context: ISyncMediaObjectRendererContext, playerOptions: DeepRequired<ISyncMediaPlayerInitOptions>): ISyncMediaObjectRendererRuntime

Inherited from ISyncMediaObjectRenderer.createRuntime

Used internally by the SyncMediaPlayer. Creates a new ISyncMediaObjectRendererRuntime instance.

Parameters
- timeline: ISyncMediaTimeline
- context: ISyncMediaObjectRendererContext
- playerOptions: DeepRequired<ISyncMediaPlayerInitOptions>
Returns ISyncMediaObjectRendererRuntime

destroyRuntime

destroyRuntime(runtime: ISyncMediaObjectRendererRuntime): void

Inherited from ISyncMediaObjectRenderer.destroyRuntime

Used internally by SyncMediaPlayer. Destroys a runtime previously created with createRuntime().

Parameters
- runtime: ISyncMediaObjectRendererRuntime
Returns void

getOptions

getOptions(): DeepRequired<ISyncMediaTtsContentBlockRendererOptions>

Get a copy of the options used by this instance.

Returns DeepRequired<ISyncMediaTtsContentBlockRendererOptions>

getSupportedMediaObjectRefType

getSupportedMediaObjectRefType(): string

Inherited from ISyncMediaObjectRenderer.getSupportedMediaObjectRefType

Get the list of SyncMediaObjectRefTypes that this renderer supports.

Returns string

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

Generated using TypeDoc