Interface IROAudioGuide

interface IROAudioGuide {
    Flush(): void;
    Say(text: string, flushSpeech: boolean, dontRepeat: boolean): number;
    Silence(duration: number): number;
}

Index

Methods

Flush Say Silence

Methods

Flush

Flush(): void
Interrupts and stops any current text-to-speech.

Returns void
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:4429

Say

Say(text: string, flushSpeech: boolean, dontRepeat: boolean): number
Speaks the given text via screen reader.
Parameters
- text: string
  The string to be spoken.
- flushSpeech: boolean
  If true, interrupts current speech immediately.
- dontRepeat: boolean
  If true, prevents repeating identical speech.
Returns number
An ID associated with the spoken string.
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:4424

Silence

Silence(duration: number): number
Suppresses background audio for clarity during speech.
Parameters
- duration: number
  Time in milliseconds to silence background audio.
Returns number
The number of milliseconds actually silenced.
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:4436