SpeechSynthesizer SpeechSynthesizer SpeechSynthesizer SpeechSynthesizer Class

Definition

public : sealed class SpeechSynthesizer : IClosable, ISpeechSynthesizer, ISpeechSynthesizer2public sealed class SpeechSynthesizer : IDisposable, ISpeechSynthesizer, ISpeechSynthesizer2Public NotInheritable Class SpeechSynthesizer Implements IDisposable, ISpeechSynthesizer, ISpeechSynthesizer2// You can use this class in JavaScript.

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute StaticAttribute

Examples

Your Windows Store app can use a SpeechSynthesizer object to create an audio stream and output speech based on a plain text string.

// The object for controlling and playing audio.
var audio = new Audio();

// The object for controlling the speech synthesis engine (voice).
var synth = new Windows.Media.SpeechSynthesis.SpeechSynthesizer();

// Generate the audio stream from plain text.
synth.synthesizeTextToStreamAsync("hello World").then(function (markersStream) {

    // Convert the stream to a URL Blob.
    var blob = MSApp.createBlobFromRandomAccessStream(markersStream.ContentType, markersStream);

    // Send the Blob to the audio object.
    audio.src = URL.createObjectURL(blob, { oneTimeOnly: true });
    audio.play();
});

// The media object for controlling and playing audio.
MediaElement mediaElement = this.media;

// The object for controlling the speech synthesis engine (voice).
var synth = new Windows.Media.SpeechSynthesis.SpeechSynthesizer();

// Generate the audio stream from plain text.
SpeechSynthesisStream stream = await synth.SynthesizeTextToStreamAsync("Hello World");

// Send the stream to the media object.
mediaElement.SetSource(stream, stream.ContentType);
mediaElement.Play();

// The object for controlling the speech synthesis engine (voice).
synth = ref new SpeechSynthesizer();
// The media object for controlling and playing audio.
media = ref new MediaElement();
// The string to speak.
String^ text = "Hello World";

// Generate the audio stream from plain text.
task<SpeechSynthesisStream ^> speakTask = create_task(synth->SynthesizeTextToStreamAsync(text));
speakTask.then([this, text](SpeechSynthesisStream ^speechStream)
{
	// Send the stream to the media object.
	// media === MediaElement XAML object.
	media->SetSource(speechStream, speechStream->ContentType);
	media->AutoPlay = true;
	media->Play();
});

// The string to speak with SSML customizations.
var Ssml = "<speak version='1.0' " +
    "xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='en-US'>" +
    "Hello <prosody contour='(0%,+80Hz) (10%,+80%) (40%,+80Hz)'>World</prosody> " + 
    "<break time='500ms'/>" +
    "Goodbye <prosody rate='slow' contour='(0%,+20Hz) (10%,+30%) (40%,+10Hz)'>World</prosody>" +
    "</speak>";

// The object for controlling and playing audio.
var audio = new Audio();

// The object for controlling the speech synthesis engine (voice).
var synth = new Windows.Media.SpeechSynthesis.SpeechSynthesizer();

// Generate the audio stream from plain text.
synth.synthesizeSsmlToStreamAsync(Ssml).then(function(synthesisStream){

    // Convert the stream to a URL Blob.
    var blob = MSApp.createBlobFromRandomAccessStream(synthesisStream.ContentType, synthesisStream);

    // Send the Blob to the audio object.
    audio.src = URL.createObjectURL(blob, { oneTimeOnly: true });
    audio.play();
});

// The string to speak with SSML customizations.
string Ssml =
    @"<speak version='1.0' " +
    "xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='en-US'>" +
    "Hello <prosody contour='(0%,+80Hz) (10%,+80%) (40%,+80Hz)'>World</prosody> " + 
    "<break time='500ms'/>" +
    "Goodbye <prosody rate='slow' contour='(0%,+20Hz) (10%,+30%) (40%,+10Hz)'>World</prosody>" +
    "</speak>";

// The media object for controlling and playing audio.
MediaElement mediaElement = this.media;

// The object for controlling the speech synthesis engine (voice).
var synth = new Windows.Media.SpeechSynthesis.SpeechSynthesizer();

// Generate the audio stream from plain text.
SpeechSynthesisStream stream = await synth.synthesizeSsmlToStreamAsync(Ssml);

// Send the stream to the media object.
mediaElement.SetSource(stream, stream.ContentType);
mediaElement.Play();

// The object for controlling the speech synthesis engine (voice).
synth = ref new SpeechSynthesizer();
// The media object for controlling and playing audio.
media = ref new MediaElement();
// The string to speak.
String^ ssml =
	"<speak version='1.0' "
	"xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='en-US'>"
	"Hello <prosody contour='(0%,+80Hz) (10%,+80%) (40%,+80Hz)'>World</prosody>"
	"<break time='500ms' /> "
	"Goodbye <prosody rate='slow' contour='(0%,+20Hz) (10%,+30%) (40%,+10Hz)'>World</prosody>"
	"</speak>";

// Generate the audio stream from SSML.
task<SpeechSynthesisStream ^> speakTask = create_task(synth->SynthesizeSsmlToStreamAsync(ssml));
speakTask.then([this, ssml](SpeechSynthesisStream ^speechStream)
{
	// Send the stream to the media object.
	// media === MediaElement XAML object.
	media->SetSource(speechStream, speechStream->ContentType);
	media->AutoPlay = true;
	media->Play();
});

public : SpeechSynthesizer()public SpeechSynthesizer()Public Sub New()// You can use this method in JavaScript.

public : static IVectorView<VoiceInformation> AllVoices { get; }public static IReadOnlyList<VoiceInformation> AllVoices { get; }Public Static ReadOnly Property AllVoices As IReadOnlyList<VoiceInformation>// You can use this property in JavaScript.

public : static VoiceInformation DefaultVoice { get; }public static VoiceInformation DefaultVoice { get; }Public Static ReadOnly Property DefaultVoice As VoiceInformation// You can use this property in JavaScript.

public : SpeechSynthesizerOptions Options { get; }public SpeechSynthesizerOptions Options { get; }Public ReadOnly Property Options As SpeechSynthesizerOptions// You can use this property in JavaScript.

public : VoiceInformation Voice { get; set; }public VoiceInformation Voice { get; set; }Public ReadWrite Property Voice As VoiceInformation// You can use this property in JavaScript.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

public : IAsyncOperation<SpeechSynthesisStream> SynthesizeSsmlToStreamAsync(PlatForm::String Ssml)public IAsyncOperation<SpeechSynthesisStream> SynthesizeSsmlToStreamAsync(String Ssml)Public Function SynthesizeSsmlToStreamAsync(Ssml As String) As IAsyncOperation( Of SpeechSynthesisStream )// You can use this method in JavaScript.

public : IAsyncOperation<SpeechSynthesisStream> SynthesizeTextToStreamAsync(PlatForm::String text)public IAsyncOperation<SpeechSynthesisStream> SynthesizeTextToStreamAsync(String text)Public Function SynthesizeTextToStreamAsync(text As String) As IAsyncOperation( Of SpeechSynthesisStream )// You can use this method in JavaScript.

public : static IAsyncOperation<PlatForm::Boolean> TrySetDefaultVoiceAsync(VoiceInformation voice)public static IAsyncOperation<bool> TrySetDefaultVoiceAsync(VoiceInformation voice)Public Static Function TrySetDefaultVoiceAsync(voice As VoiceInformation) As IAsyncOperation( Of bool )// You can use this method in JavaScript.

<Capabilities><iot:Capability Name="systemManagement"/></Capabilities>

See Also

• VoiceInformation VoiceInformation VoiceInformation VoiceInformation
• Speech interactions
• Speech design guidelines
• Speech recognition and speech synthesis sample