Class GeneratorPool<N, T, D>

adaptor

promise

options

• set options(options: OptionList): void

  Option setter that takes care of setting up SRE and assembling the options for the speech generators.

  Parameters

  • options: OptionList

    The option list.

  Returns void

cancel

• cancel(item: SpeechMathItem<N, T, D>): void

  Cancel a pending speech task

  Parameters

  • item: SpeechMathItem<N, T, D>

    The SpeechMathItem whose task is to be cancelled

  Returns void

getBraille

• getBraille(node: N): string

  Computes the braille label from the node.

  Parameters

  • node: N

    The typeset node.

  Returns string

  The assembled label.

getLabel

• getLabel(node: N, _center?: string, sep?: string): string

  Computes the speech label from the node combining prefixes and postfixes.

  Parameters

  • node: N

    The typeset node.
  • _center: string = ''

    Core speech. Defaults to data-semantic-speech.
  • sep: string = ' '

    The speech separator. Defaults to space.

  Returns string

  The assembled label.

getLocalePreferences

• getLocalePreferences(
      prefs: Map<string, { [prop: string]: string[] }>,
  ): Promise<void>

  Computes the clearspeak preferences for the current locale.

  Parameters

  • prefs: Map<string, { [prop: string]: string[] }>

    Map to store the compute preferences.

  Returns Promise<void>

  The promise that resolves when the command is complete

getRelevantPreferences

• getRelevantPreferences(
      item: SpeechMathItem<N, T, D>,
      semantic: string,
      prefs: Map<number, string>,
      counter: number,
  ): Promise<void>

  Computes the clearspeak preferences that are semantically relevant for the currently focused node.

  Parameters

  • item: SpeechMathItem<N, T, D>

    The SpeechMathItem where is menu is opened.
  • semantic: string

    The semantic id of the last focused node.
  • prefs: Map<number, string>

    Map for recording the computed preference.
  • counter: number

    Counter for storing the result in the map.

  Returns Promise<void>

  The promise that resolves when the command is complete

init

• init(
      options: OptionList,
      adaptor: DOMAdaptor<N, T, D>,
      webworker: WorkerHandler<N, T, D>,
  ): void

  Init method for speech generation.

  Parameters

  • options: OptionList

    A list of options.
  • adaptor: DOMAdaptor<N, T, D>

    The DOM adaptor providing access to nodes.
  • webworker: WorkerHandler<N, T, D>

    The webworker with SRE.

  Returns void

nextRules

• nextRules(item: SpeechMathItem<N, T, D>): Promise<void>

  Cycles rule sets for the speech generator.

  Parameters

  • item: SpeechMathItem<N, T, D>

    The SpeechMathItem whose rule set is changing

  Returns Promise<void>

  A promise that resolves when the command completes

nextStyle

• nextStyle(node: N, item: SpeechMathItem<N, T, D>): Promise<void>

  Cycles style or preference settings for the speech generator.

  Parameters

  • node: N

    The typeset node.
  • item: SpeechMathItem<N, T, D>

    The SpeechMathItem whose preferences are changing

  Returns Promise<void>

  A promise that resolves when the command completes

Speech

• Speech(item: SpeechMathItem<N, T, D>): Promise<void>

  Compute speech using the original MathML element as reference.

  Parameters

  • item: SpeechMathItem<N, T, D>

    The SpeechMathItem to add speech to

  Returns Promise<void>

  The promise that resolves when the command is complete

update

• update(options: OptionList): void

  Update method for speech generation options. Runs a retry until locales have been loaded.

  Parameters

  • options: OptionList

    A list of options.

  Returns void

updateRegions

• updateRegions(
      node: N,
      speechRegion: LiveRegion,
      brailleRegion: LiveRegion,
  ): void

  Updates the given speech regions, possibly reinstanting previously saved speech.

  Parameters

  • node: N

    The typeset node
  • speechRegion: LiveRegion

    The speech region.
  • brailleRegion: LiveRegion

    The braille region.

  Returns void