| FoxitPDFSDKforWeb v11.0.5 Archives Foxit PDF SDK for Web

Protected Member Functions | List of all members
PDFTextToSpeechSynthesisTemplate Class Referenceabstract
PDFViewCtrl » readAloud

Template methods to simplify the implementation of custom speech synthesizers. More...

Inheritance diagram for PDFTextToSpeechSynthesisTemplate:

## Protected Member Functions
abstract void | doPause ()
| This method is used to implement the actions that should be handled after the state is switched to paused.
abstract void | doResume ()
| This method is used to implement the actions that should be handled after resume the speech synthesis.
abstract void | doStop ()
| This method is used to implement the actions that should be handled after the state is switched to stop.
void | init ()
| Method used to initialization.
abstract void | onCurrentPlayingOptionsUpdated ()
| This method is used to implement options updates.
abstract Promise< void > | speakText (text:string, options?:ReadAloudOptions)
| This method is used to synthesize a speech based on the received parameters and play it back. More...

## Detailed Description

Template methods to simplify the implementation of custom speech synthesizers.

Since
  8.0.0

## Member Function Documentation

## ◆ speakText()

abstract Promise<void> PDFTextToSpeechSynthesisTemplate::speakText | ( | text:string | ,
|  | options?:ReadAloudOptions |
| ) |  |
| protected pure virtual

This method is used to synthesize a speech based on the received parameters and play it back.

Parameters

  text | string - The text content to be read.
  options | ReadAloudOptions | undefined - Options of the speech synthesizer.

Returns
  Promise<void>

@2025 Foxit Software Incorporated. All rights reserved.