SpeechSynthesisStream Class

Definition

Namespace:

Windows.Media.SpeechSynthesis

Supports reading and writing audio data generated by the speech synthesis engine (voice) to/from a random access stream.

public ref class SpeechSynthesisStream sealed : IClosable, ITimedMetadataTrackProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SpeechSynthesisStream final : IClosable, ITimedMetadataTrackProvider

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SpeechSynthesisStream : System.IDisposable, ITimedMetadataTrackProvider

Public NotInheritable Class SpeechSynthesisStream
Implements IDisposable, ITimedMetadataTrackProvider

Inheritance

Object Platform::Object IInspectable SpeechSynthesisStream

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IClosable IDisposable IContentTypeProvider IInputStream IOutputStream IRandomAccessStream IRandomAccessStreamWithContentType ITimedMetadataTrackProvider

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

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

// 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.
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();
});

Remarks

Version history

Windows version	SDK version	Value added
1703	15063	TimedMetadataTracks

Properties

CanRead	Gets whether SpeechSynthesisStream can be read from.
CanWrite	Gets a value that indicates whether SpeechSynthesisStream can be written to.
ContentType	Gets the MIME type of the content of SpeechSynthesisStream.
Markers	Gets the collection of timeline markers associated with the SpeechSynthesisStream. Note SpeechSynthesisStream.Markers is deprecated. We recommend using the MediaPlayerElement and MediaPlaybackItem objects instead (in conjunction with the IncludeSentenceBoundaryMetadata and IncludeWordBoundaryMetadata properties of a SpeechSynthesizerOptions object).
Position	Gets the current position within the SpeechSynthesisStream.
Size	Gets or sets the size of the SpeechSynthesisStream.
TimedMetadataTracks	Gets the collection of optional word and sentence boundaries in the speech synthesis stream as specified by the SpeechSynthesizer.Options property.

Methods

CloneStream()	Creates a copy of SpeechSynthesisStream that references the same bytes as the original stream.
Close()	Releases system resources that are exposed by SpeechSynthesisStream.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
FlushAsync()	Flushes data asynchronously in a sequential stream.
GetInputStreamAt(UInt64)	Retrieves an input stream at a specified location in SpeechSynthesisStream.
GetOutputStreamAt(UInt64)	Retrieves an output stream at a specified location in SpeechSynthesisStream.
ReadAsync(IBuffer, UInt32, InputStreamOptions)	Reads data asynchronously in a sequential stream.
Seek(UInt64)	Goes to the specified position within SpeechSynthesisStream.
WriteAsync(IBuffer)	Writes data asynchronously in a sequential stream.

See also

• Windows.Media.SpeechSynthesis
• IRandomAccessStreamWithContentType
• IRandomAccessStream
• IClosable
• IInputStream
• IOutputStream
• IContentTypeProvider
• Speech interactions
• Speech recognition and speech synthesis sample