Sticky Key Panel - Text to Speech API

Sticky Key Panel - Text to Speech Overview

Adds the self-voicing to read the instructions at the various stages of the Sticky Key Panel workflow. This component is not intended to be used on its own, but provided as a grade to the Sticky Key Panel Component. This component also relies on the availability of a component with the fluid.textToSpeech grade within the component hierarchy to do the actual speaking.


Adding a Sticky Key Panel - Text to Speech to a Component/Grade

To mixin the Sticky Key Panel - Text to Speech into the Sticky Key Panel Component by supplying it as a gradeNames option in an Auxiliary Schema:

 

"keyboard": {
    "type": "gpii.firstDiscovery.stickyKeys",
    "panel": {
        "type": "gpii.firstDiscovery.panel.keyboard",
        "container": ".gpiic-fd-prefsEditor-panel-keyboard",
        "gradeNames": ["gpii.firstDiscovery.panel.keyboardTts"],
        "template": "%prefix/keyboard.html",
        "message": "%prefix/keyboard.json"
    }
}

 

Methods

Method

Description

Parameters

speakStickyKeysState

Announces whether or not the sticky key preference is turned on.

Object: an instance of gpii.firstDiscovery.panel.keyboardTts

Boolean: the state of the sticky key preference

speakPanelInstructionsSpeaks the panel instruction.

None

Dependencies

<script type="text/javascript" src="src/lib/infusion/infusion-custom.js"></script>
<script type="text/javascript" src="src/js/panels.js"></script>