Partager via


Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

SpeechSynthesizer Members

Include Protected Members
Include Inherited Members

Provides access to the functionality of an installed a speech synthesis engine.

The SpeechSynthesizer type exposes the following members.

Constructors

  Name Description
Public method SpeechSynthesizer Initializes a new instance of the SpeechSynthesizer class.

Top

Properties

  Name Description
Public property Rate Gets or sets the speaking rate of the SpeechSynthesizer object.
Public property State Gets the speaking state of the SpeechSynthesizer object.
Public property TtsVolume Gets or sets the volume (loudness) of the synthesized speech in the SpeechSynthesizer's audio output.
Public property Voice Gets information about the current voice of the SpeechSynthesizer object.
Public property Volume Get or sets the output volume of the SpeechSynthesizer object.

Top

Methods

  Name Description
Public method AddLexicon Adds a lexicon to the SpeechSynthesizer object.
Public method Dispose Disposes the SpeechSynthesizer object and releases resources used during the session.
Public method Equals (inherited from Object)
Protected method Finalize Acts as a safeguard to clean up resources in the event that the Dispose() method is not called. (Overrides Object.Finalize().)
Public method GetCurrentlySpokenPrompt Gets the contents of the prompt that the SpeechSynthesizer is speaking.
Public method GetHashCode (inherited from Object)
Public method GetInstalledVoices() Returns all of the installed speech synthesis (text-to-speech) voices.
Public method GetInstalledVoices(CultureInfo) Returns all of the installed speech synthesis (text-to-speech) voices that support a specific locale.
Public method GetType (inherited from Object)
Protected method MemberwiseClone (inherited from Object)
Public method Pause Pauses the SpeechSynthesizer object.
Public method RemoveLexicon Removes a lexicon from the SpeechSynthesizer object.
Public method Resume Resumes the speaking of a prompt by the SpeechSynthesizer object after it has been paused.
Public method SelectVoice Selects a specific voice by name.
Public method SelectVoiceByHints(VoiceGender) Selects a voice with a specific gender.
Public method SelectVoiceByHints(VoiceGender, VoiceAge) Selects a voice with a specific gender and age.
Public method SelectVoiceByHints(VoiceGender, VoiceAge, Int32) Selects a voice with a specific gender and age, based on the position in which the voices are ordered.
Public method SelectVoiceByHints(VoiceGender, VoiceAge, Int32, CultureInfo) Selects a voice with a specific gender, age, and locale, based on the position in which the voices are ordered.
Public method SetOutputToAudioStream Configures the SpeechSynthesizer object to append output to a stream that contains Waveform format audio.
Public method SetOutputToDefaultAudioDevice Configures the SpeechSynthesizer object to send output to the default audio device for the system.
Public method SetOutputToNull Configures the SpeechSynthesizer object to not send output from synthesis operations to a device, file, or stream.
Public method SetOutputToWaveFile(String) Configures the SpeechSynthesizer object to append output to a file that contains Waveform format audio.
Public method SetOutputToWaveFile(String, SpeechAudioFormatInfo) Configures the SpeechSynthesizer object to append output to a Waveform audio format file in a specified format.
Public method SetOutputToWaveStream Configures the SpeechSynthesizer object to append output to a stream that contains Waveform format audio.
Public method Skip Skips the specified amount of time in a prompt.
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.
Public method SpeakAsync(String) Asynchronously speaks the contents of a string.
Public method SpeakAsync(Prompt) Asynchronously speaks the contents of a Prompt object.
Public method SpeakAsync(PromptBuilder) Asynchronously speaks the contents of a PromptBuilder object.
Public method SpeakAsyncCancel Cancels the asynchronous synthesis operation for a queued prompt.
Public method SpeakAsyncCancelAll Cancels all queued, asynchronous, speech synthesis operations.
Public method SpeakSsml Asynchronously speaks a String that contains SSML markup.
Public method SpeakSsmlAsync Asynchronously speaks a String that contains SSML markup.
Public method ToString (inherited from Object)

Top

Events

  Name Description
Public event BookmarkReached Raised when the SpeechSynthesizer encounters a bookmark in a prompt.
Public event ProprietaryEngineEvent This event is for use by developers of custom speech synthesis engines.
Public event SpeakCompleted Raised when the SpeechSynthesizer completes the speaking of a prompt.
Public event SpeakProgress Raised after the SpeechSynthesizer speaks each individual word of a prompt.
Public event SpeakStarted Raised when the SpeechSynthesizer begins the speaking of a prompt.
Public event StateChanged Raised when the state of the SpeechSynthesizer changes.
Public event VoiceChange Raised when the voice of the SpeechSynthesizer changes.

Top

See Also

Reference

SpeechSynthesizer Class

Microsoft.Speech.Synthesis Namespace