SpeechSynthesizerOptions
SpeechSynthesizerOptions
SpeechSynthesizerOptions
SpeechSynthesizerOptions
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Provides access to various speech synthesizer options.
public : sealed class SpeechSynthesizerOptions : ISpeechSynthesizerOptionspublic sealed class SpeechSynthesizerOptions : ISpeechSynthesizerOptionsPublic NotInheritable Class SpeechSynthesizerOptions Implements ISpeechSynthesizerOptions// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Properties
AudioPitch AudioPitch AudioPitch AudioPitch
Prerelease. Gets or sets the tone (relative highness or lowness) of the speech synthesis utterance.
public : double AudioPitch { get; set; }public double AudioPitch { get; set; }Public ReadWrite Property AudioPitch As double// You can use this property in JavaScript.
- Value
- double double double double
The tone of the selected speech synthesis engine (voice).
This value can range from 0.0 (lowest pitch) to 2.0 (highest pitch), inclusive. The default value is 1.0.
Some voices have a minimum speaking pitch higher than 0.0 and a maximum speaking pitch lower than 2.0.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
If Speech Synthesis Markup Language (SSML) is used, AudioPitch is combined with any prosody tags in the markup.
Note
Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants).
AudioVolume AudioVolume AudioVolume AudioVolume
Prerelease. Gets or sets the loudness of the speech synthesis utterance.
public : double AudioVolume { get; set; }public double AudioVolume { get; set; }Public ReadWrite Property AudioVolume As double// You can use this property in JavaScript.
- Value
- double double double double
The loudness of the selected speech synthesis engine (voice).
This value can range from 0.0 (lowest volume) to 1.0 (highest volume), inclusive. The default value is 1.0.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
If Speech Synthesis Markup Language (SSML) is used, AudioVolume is combined with any prosody tags in the markup.
Note
Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants).
IncludeSentenceBoundaryMetadata IncludeSentenceBoundaryMetadata IncludeSentenceBoundaryMetadata IncludeSentenceBoundaryMetadata
Gets or sets whether sentence boundary metadata is added to a SpeechSynthesisStream object.
public : PlatForm::Boolean IncludeSentenceBoundaryMetadata { get; set; }public bool IncludeSentenceBoundaryMetadata { get; set; }Public ReadWrite Property IncludeSentenceBoundaryMetadata As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if sentence boundaries are marked. Otherwise, false.
IncludeWordBoundaryMetadata IncludeWordBoundaryMetadata IncludeWordBoundaryMetadata IncludeWordBoundaryMetadata
Gets or sets whether word boundary metadata is added to a SpeechSynthesisStream object.
public : PlatForm::Boolean IncludeWordBoundaryMetadata { get; set; }public bool IncludeWordBoundaryMetadata { get; set; }Public ReadWrite Property IncludeWordBoundaryMetadata As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if word boundaries are marked. Otherwise, false.
SpeakingRate SpeakingRate SpeakingRate SpeakingRate
Prerelease. Gets or sets the tempo (including pauses and hesitations) of the speech synthesis utterance.
public : double SpeakingRate { get; set; }public double SpeakingRate { get; set; }Public ReadWrite Property SpeakingRate As double// You can use this property in JavaScript.
- Value
- double double double double
The tempo, relative to the default rate of the selected speech synthesis engine (voice).
This value can range from 0.5 (half the default rate) to 6.0 (6x the default rate), inclusive. The default value is 1.0 (the "normal" speaking rate for the current voice).
Some voices have minimum speaking rates faster than 0.5 and maximum speaking rates slower than 6.0.
Note
Speaking rate cannot be directly translated to words-per-minute because each voice and language can have a different default speaking rate.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
If Speech Synthesis Markup Language (SSML) is used, SpeakingRate is combined with any prosody tags in the markup.
Note
Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants).