Skip to content

Commit

Permalink
update documentation, phetsims/sun#726
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Mar 3, 2022
1 parent 67bcb64 commit 6a85291
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion js/accessibility/voicing/Voicing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,32 @@ const VOICING_OPTION_KEYS = [
];

type VoicingSelfOptions = {

// see ResponsePacket.nameResponse
voicingNameResponse?: VoicingResponse,

// see ResponsePacket.objectResponse
voicingObjectResponse?: VoicingResponse,

// see ResponsePacket.contextResponse
voicingContextResponse?: VoicingResponse,

// see ResponsePacket.hintResponse
voicingHintResponse?: VoicingResponse,
voicingUtteranceQueue?: UtteranceQueue,

// see ResponsePacket.responsePatternCollection
voicingResponsePatternCollection?: ResponsePatternCollection,

// see ResponsePacket.ignoreProperties
voicingIgnoreVoicingManagerProperties?: boolean,

// Called when this Node is focused to speak voicing responses on focus. See Voicing.defaultFocusListener for default
// listener.
voicingFocusListener?: SceneryListenerFunction<FocusEvent> | null

// By default use voicingUtteranceQueue to speak responses, but you can also specify another utteranceQueue here.
voicingUtteranceQueue?: UtteranceQueue,

// 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.
voicingUtterance?: Utterance;
Expand Down

0 comments on commit 6a85291

Please sign in to comment.