SpeechSynthesizer.SetOutputToWaveStream(Stream) Method

Definition

Namespace:

System.Speech.Synthesis

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0

Source:

SpeechSynthesizer.cs

Configures the SpeechSynthesizer object to append output to a stream that contains Waveform format audio.

public:
 void SetOutputToWaveStream(System::IO::Stream ^ audioDestination);

public void SetOutputToWaveStream (System.IO.Stream audioDestination);

member this.SetOutputToWaveStream : System.IO.Stream -> unit

Public Sub SetOutputToWaveStream (audioDestination As Stream)

Parameters

audioDestination

Stream

The stream to which to append synthesis output.

Examples

The following example outputs a phrase to a WAV stream.

using System;
using System.IO;
using System.Speech.Synthesis;

namespace SampleSynthesis
{
  class Program
  {
    static void Main(string[] args)
    {

      // Initialize a new instance of the speech synthesizer.
      using (SpeechSynthesizer synth = new SpeechSynthesizer())
      using (MemoryStream streamAudio = new MemoryStream())
      {

        // Create a SoundPlayer instance to play the output audio file.
        System.Media.SoundPlayer m_SoundPlayer = new System.Media.SoundPlayer();

        // Configure the synthesizer to output to an audio stream.
        synth.SetOutputToWaveStream(streamAudio);

        // Speak a phrase.
        synth.Speak("This is sample text-to-speech output.");
        streamAudio.Position = 0;
        m_SoundPlayer.Stream = streamAudio;
        m_SoundPlayer.Play();

        // Set the synthesizer output to null to release the stream.
        synth.SetOutputToNull();

        // Insert code to persist or process the stream contents here.
      }

      Console.WriteLine();
      Console.WriteLine("Press any key to exit...");
      Console.ReadKey();
    }
  }
}

Remarks

To release the SpeechSynthesizer's reference to the stream, reconfigure the synthesizer's output, for example, by calling SetOutputToNull.

For other output configuration options, see the SetOutputToAudioStream, SetOutputToDefaultAudioDevice, SetOutputToNull, and SetOutputToWaveFile methods.