SpeechSynthesizer Members

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

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

The SpeechSynthesizer type exposes the following members.

Constructors

  NameDescription
Public methodSpeechSynthesizerInitializes a new instance of the SpeechSynthesizer class.
Top

Properties

  NameDescription
Public propertyRateGets or sets the speaking rate of the SpeechSynthesizer object.
Public propertyStateGets the speaking state of the SpeechSynthesizer object.
Public propertyTtsVolumeGets or sets the volume (loudness) of the synthesized speech in the SpeechSynthesizer's audio output.
Public propertyVoiceGets information about the current voice of the SpeechSynthesizer object.
Public propertyVolumeGet or sets the output volume of the SpeechSynthesizer object.
Top

Methods

  NameDescription
Public methodAddLexiconAdds a lexicon to the SpeechSynthesizer object.
Public methodDisposeDisposes the SpeechSynthesizer object and releases resources used during the session.
Public methodEquals (Inherited from Object.)
Protected methodFinalizeActs as a safeguard to clean up resources in the event that the Dispose()()()() method is not called. (Overrides Object..::..Finalize()()()().)
Public methodGetCurrentlySpokenPromptGets the contents of the prompt that the SpeechSynthesizer is speaking.
Public methodGetHashCode (Inherited from Object.)
Public methodGetInstalledVoices()()()()Returns all of the installed speech synthesis (text-to-speech) voices.
Public methodGetInstalledVoices(CultureInfo)Returns all of the installed speech synthesis (text-to-speech) voices that support a specific locale.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodPausePauses the speaking of a prompt by a SpeechSynthesizer object.
Public methodRemoveLexiconRemoves a lexicon from the SpeechSynthesizer object.
Public methodResumeResumes the speaking of a prompt by the SpeechSynthesizer object after it has been paused.
Public methodSelectVoiceSelects a specific voice by name.
Public methodSelectVoiceByHints(VoiceGender)Selects a voice with a specific gender.
Public methodSelectVoiceByHints(VoiceGender, VoiceAge)Selects a voice with a specific gender and age.
Public methodSelectVoiceByHints(VoiceGender, VoiceAge, Int32)Selects a voice with a specific gender and age, based on the position in which the voices are ordered.
Public methodSelectVoiceByHints(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 methodSetOutputToAudioStreamConfigures the SpeechSynthesizer object to append output to a stream that contains Waveform format audio.
Public methodSetOutputToDefaultAudioDeviceConfigures the SpeechSynthesizer object to send output to the default audio device for the system.
Public methodSetOutputToNullConfigures the SpeechSynthesizer object to not send output from synthesis operations to a device, file, or stream.
Public methodSetOutputToWaveFile(String)Configures the SpeechSynthesizer object to append output to a file that contains Waveform format audio.
Public methodSetOutputToWaveFile(String, SpeechAudioFormatInfo)Configures the SpeechSynthesizer object to append output to a Waveform audio format file in a specified format.
Public methodSetOutputToWaveStreamConfigures the SpeechSynthesizer object to append output to a stream that contains Waveform format audio.
Public methodSkipSkips the specified amount of time in a prompt.
Public methodSpeak(String)Synchronously speaks the contents of a string.
Public methodSpeak(Prompt)Synchronously speaks the contents of a Prompt object.
Public methodSpeak(PromptBuilder)Synchronously speaks the contents of a PromptBuilder object.
Public methodSpeakAsync(String)Asynchronously speaks the contents of a string.
Public methodSpeakAsync(Prompt)Asynchronously speaks the contents of a Prompt object.
Public methodSpeakAsync(PromptBuilder)Asynchronously speaks the contents of a PromptBuilder object.
Public methodSpeakAsyncCancelCancels the asynchronous synthesis operation for a queued prompt.
Public methodSpeakAsyncCancelAllCancels all queued, asynchronous, speech synthesis operations.
Public methodSpeakSsmlAsynchronously speaks a String that contains SSML markup.
Public methodSpeakSsmlAsyncAsynchronously speaks a String that contains SSML markup.
Public methodToString (Inherited from Object.)
Top

Events

  NameDescription
Public eventBookmarkReachedRaised when the SpeechSynthesizer encounters a bookmark in a prompt.
Public eventProprietaryEngineEventThis event is for use by developers of custom speech synthesis engines.
Public eventSpeakCompletedRaised when the SpeechSynthesizer completes the speaking of a prompt.
Public eventSpeakProgressRaised after the SpeechSynthesizer speaks each individual word of a prompt.
Public eventSpeakStartedRaised when the SpeechSynthesizer begins the speaking of a prompt.
Public eventStateChangedRaised when the state of the SpeechSynthesizer changes.
Public eventVoiceChangeRaised when the voice of the SpeechSynthesizer changes.
Top

See Also