Creates a new SyncMediaTtsContentBlockRenderer.
The ITtsSynthesizer that is responsible for synthesized speech.
The annotation layer to use for highlighting spoken text. Use null to disable highlighting.
Used internally by the SyncMediaPlayer. Creates a new ISyncMediaObjectRendererRuntime instance.
Used internally by SyncMediaPlayer. Destroys a runtime previously created with createRuntime().
Get a copy of the options used by this instance.
Get the list of SyncMediaObjectRefTypes that this renderer supports.
Get the annotation layer used for highlighting spoken text.
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.
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.
Generated using TypeDoc
The SyncMediaTtsContentBlockRenderer is used for speaking text that was generated from ContentBlock instances. Speech is generated using a ITtsSynthesizer, which must be passed as a parameter to the constructor. Highlighting of the spoken text is done using a ReaderViewAnnotationLayer which you can also pass to the constructor.
This renderer is compatible with SyncMediaObjectRefs with the type SyncMediaObjectRefType.TTS_CONTENT_BLOCK.