getTextToSpeech

Returns the runtime's text-to-speech API, for speaking text whether or not the screen reader is on

import { getTextToSpeech } from "@roku-sdk/runtime/text-to-speech";
getTextToSpeech(): TextToSpeech

Description

Returns the runtime's text-to-speech API, for speaking text whether or not the screen reader is on.

Use it for speech that is part of the app's own behavior, and control the rate, pitch and volume on the returned object. To announce content for the screen reader, use getAudioGuide instead. The object is created on the first call and reused afterwards.

Return values

The runtime's TextToSpeech object.


What’s Next

Did this page help you?