SpeechSynthesizer.Speak Method

Generates speech output synchronously from a string, a Prompt object, or a PromptBuilder object.

  NameDescription
Public method Speak(String) Synchronously speaks the contents of a string.
Public method Speak(Prompt) Synchronously speaks the contents of a Prompt object.
Public method Speak(PromptBuilder) Synchronously speaks the contents of a PromptBuilder object.
Top

The Speak() methods generate speech synchronously. The methods do not return until the content of the Speak() instance has been completely spoken. This is the simplest way to generate speech. However, if your application needs to perform tasks while speaking, for example highlight text, paint animation, monitor controls, or other tasks, use the SpeakAsync() methods or the SpeakSsmlAsync(String) method to generate speech asynchronously.

During a call to this method, the SpeechSynthesizer can raise the following events:

  • StateChanged. Raised when the speaking state of the synthesizer changes.

  • SpeakStarted. Raised when the synthesizer begins generating speech.

  • SpeakProgress. Raised each time the synthesizer completes speaking a word.

  • BookmarkReached. Raised when the synthesizer encounters a bookmark in a prompt.

  • VoiceChange. Raised when the speaking voice for the synthesizer changes.

The SpeechSynthesizer does not raise the SpeakCompleted event while processing any of the Speak() methods.

Show: