Skip to content

Voicing

Overview

A trait for Node that supports the Voicing feature, under accessibility. Allows you to define responses for the Node and make requests to speak that content using HTML5 SpeechSynthesis and the UtteranceQueue. Voicing content is organized into four categories which are responsible for describing different things. Responses are stored on the composed type: "ResponsePacket." See that file for details about what responses it stores. Output of this content can be controlled by the responseCollector. Responses are defined as the following. . .

  • "Name" response: The name of the object that uses Voicing. Similar to the "Accessible Name" in web accessibility.
  • "Object" response: The state information about the object that uses Voicing.
  • "Context" response: The contextual changes that result from interaction with the Node that uses Voicing.
  • "Hint" response: A supporting hint that guides the user toward a desired interaction with this Node.

See ResponsePacket, as well as the property and setter documentation for each of these responses for more information.

Once this content is set, you can make a request to speak it using an UtteranceQueue with one of the provided functions in this Trait. It is up to you to call one of these functions when you wish for speech to be made. The only exception is on the 'focus' event. Every Node that composes Voicing will speak its responses by when it receives focus.

@author Jesse Greenberg (PhET Interactive Simulations) @author Michael Kauzmann (PhET Interactive Simulations)

Type SpeakingOptions

import type { SpeakingOptions } from 'scenerystack/scenery';
  • utterance?: SelfOptions['voicingUtterance']
  • & SpeakableResolvedOptions

Type VoicingNode

import type { VoicingNode } from 'scenerystack/scenery';

Node & TVoicing

Type VoicingOptions

import type { VoicingOptions } from 'scenerystack/scenery';
  • voicingNameResponse?: VoicingResponse
    see ResponsePacket.nameResponse
  • voicingObjectResponse?: VoicingResponse
    see ResponsePacket.objectResponse
  • voicingContextResponse?: VoicingResponse
    see ResponsePacket.contextResponse
  • voicingHintResponse?: VoicingResponse
    see ResponsePacket.hintResponse
  • voicingResponsePatternCollection?: ResponsePatternCollection
    see ResponsePacket.responsePatternCollection
  • voicingIgnoreVoicingManagerProperties?: boolean
    see ResponsePacket.ignoreProperties
  • voicingFocusListener?: SceneryListenerFunction<FocusEvent> | null
    Called when this Node is focused to speak voicing responses on focus. See Voicing.defaultFocusListener for default listener.
  • voicingUtterance?: Utterance | null
    The utterance to use if you want this response to be more controlled in the UtteranceQueue. This Utterance will be used by all responses spoken by this class. Null to not use an Utterance.
  • & InteractiveHighlightingOptions

Source Code

See the source for Voicing.ts in the scenery repository.