getVoiceDictation
Returns the roVoiceDictation runtime instance, used to control keyboard voice-entry sessions (start/stop listening, switch keyboard domain, report text-box state)
import { getVoiceDictation } from "@roku-sdk/runtime/voice-dictation";getVoiceDictation(): VoiceDictationDescription
Returns the roVoiceDictation runtime instance, used to control keyboard voice-entry sessions (start/stop listening, switch keyboard domain, report text-box state).
The instance is cached after the first call. Recognized dictation text is not returned by this API — subscribe to useVoiceDictation to receive dictation events (start / text / end) reactively.
Return values
The cached VoiceDictation instance.
Example
const voiceDictation = getVoiceDictation();
const { dictationParams } = useVoiceDictation();
voiceDictation.setUseVoiceEntry(DictationKeyboardType.Generic);
voiceDictation.updateDictationParams("", 0, 200);
voiceDictation.pressedSoftMicButton();
createEffect(() => {
const params = dictationParams();
if (params?.dictation_event === DictationEvent.Text) {
// ...append params.text...
}
});
// ...user finishes...
voiceDictation.releasedSoftMicButton();
voiceDictation.clearVoiceEntry();Updated about 4 hours ago
What’s Next
Did this page help you?