ISyncMediaTtsContentBlockRefSource | Colibrio Reader Framework API

Describes how the TTS text was generated from a ContentBlock.

Hierarchy

ISyncMediaTtsContentBlockRefSource

Index

Properties

Readonly contentBlockId

contentBlockId: number

The id of the content block referenced by this instance.

int

Readonly endOffset

endOffset: number

The end offset into the source contentBlock referenced.

int

Readonly srcMap

srcMap: string

Describes how the ContentBlock string was modified into the text.value string intended for the SpeechSynthesis engine. An example srcMap value is: "A0:7,D0:3,D9:2"

Operations:

Add (offset, count): A: For example: The string "A dog." => "Image: A dog" would result in: Add (offset: 0, count: 7) "A0:7"
Delete (offset, count): D: For example " Some text " => "Some text" would result in: Delete(0, 3), Delete(9, 2) "D0:3,D9:2"
Replace (offset, deleteCount, addCount): R:: Replace operations are treated as a Delete + Add action. "R5:8:1"

Readonly startOffset

startOffset: number

The start offset into the source contentBlock text referenced.

int

Readonly ttsOffset

ttsOffset: number

The start offset into the mutated ttsRef.text.value where its content corresponds to this instance.

int