getAudioGuide

Returns the runtime's Audio Guide, which speaks text through the device's screen reader

import { getAudioGuide } from "@roku-sdk/runtime/audio-guide";

getAudioGuide(): AudioGuide

Description

Returns the runtime's Audio Guide, which speaks text through the device's screen reader.

Use it to announce app content to users who have Audio Guide turned on, for CVAA accessibility. For general-purpose speech that is not tied to the screen reader, use getTextToSpeech. The object is created on the first call and reused afterwards.

Return values

The runtime's AudioGuide object.