System.Speech
9.0.0-preview.4.24266.19
Prefix Reserved
See the version list below for details.
dotnet add package System.Speech --version 9.0.0-preview.4.24266.19
NuGet\Install-Package System.Speech -Version 9.0.0-preview.4.24266.19
<PackageReference Include="System.Speech" Version="9.0.0-preview.4.24266.19" />
paket add System.Speech --version 9.0.0-preview.4.24266.19
#r "nuget: System.Speech, 9.0.0-preview.4.24266.19"
// Install System.Speech as a Cake Addin #addin nuget:?package=System.Speech&version=9.0.0-preview.4.24266.19&prerelease // Install System.Speech as a Cake Tool #tool nuget:?package=System.Speech&version=9.0.0-preview.4.24266.19&prerelease
About
Provides APIs for speech recognition and synthesis built on the Microsoft Speech API in Windows. Not supported on other platforms.
This package is provided primarily for compatibility with code being ported from .NET Framework and is not accepting new features.
Key Features
- Recognize speech as text in a given language and grammar.
- Synthesize text as speech.
- Support for Speech Recognition Grammar v1.0 documents
How to Use
Synthesis example
using System.Speech.Synthesis;
// Initialize a new instance of the SpeechSynthesizer.
SpeechSynthesizer synth = new SpeechSynthesizer();
// Configure the audio output.
synth.SetOutputToDefaultAudioDevice();
// Speak a string, synchronously
synth.Speak("Hello World!");
// Speak a string asynchronously
var prompt = synth.SpeakAsync("Goodnight Moon!");
while (!prompt.IsCompleted)
{
Console.WriteLine("speaking...");
Thread.Sleep(500);
}
Recognition example
// Create a new SpeechRecognitionEngine instance.
using SpeechRecognizer recognizer = new SpeechRecognizer();
using ManualResetEvent exit = new ManualResetEvent(false);
// Create a simple grammar that recognizes "red", "green", "blue", or "exit".
Choices choices = new Choices();
choices.Add(new string[] { "red", "green", "blue", "exit" });
// Create a GrammarBuilder object and append the Choices object.
GrammarBuilder gb = new GrammarBuilder();
gb.Append(choices);
// Create the Grammar instance and load it into the speech recognition engine.
Grammar g = new Grammar(gb);
recognizer.LoadGrammar(g);
// Register a handler for the SpeechRecognized event.
recognizer.SpeechRecognized += (s, e) =>
{
Console.WriteLine($"Recognized: {e.Result.Text}, Confidence: {e.Result.Confidence}");
if (e.Result.Text == "exit")
{
exit.Set();
}
};
// Emulate
Console.WriteLine("Emulating \"red\".");
recognizer.EmulateRecognize("red");
Console.WriteLine("Speak red, green, blue, or exit please...");
exit.WaitOne();
Main Types
The main types provided by this library are:
System.Speech.Recognition.SpeechRecognizer
System.Speech.Synthesis.SpeechSynthesizer
Additional Documentation
Feedback & Contributing
System.Speech is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- No dependencies.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (36)
Showing the top 5 NuGet packages that depend on System.Speech:
Package | Downloads |
---|---|
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET as well as .NET Standard. |
|
Microsoft.PowerShell.SDK
Runtime for hosting PowerShell |
|
CommunityToolkit.Maui.Core
Core library for community toolkits using .NET MAUI |
|
Krypton.Toolkit.Suite.Extended.Dialogs
An extension to the Standard Toolkit, which supports .NET Framework 4.6.2 - 4.8.1, .NET 6, 8 and 9. This package implements additional extensions to standard dialogs. This package supports all .NET Framework versions starting .NET Framework 4.6.2 - 4.8.1, .NET 6, 8 and 9. Also, all libraries are included targeting each specific framework version for performance purposes. To view all of the extended toolkit package latest version information, please visit: https://github.com/Krypton-Suite/Krypton-Toolkit-Suite-Version-Dashboard/blob/main/Documents/Modules/Extended/Krypton-Toolkit-Suite-Extended-Modules.md |
|
Jon.Wpf.CustomControls
Jon.WPF.CustomControls is a collection of custom, reusable WPF controls. It is built with .NET 7.0 and intended to provide developers with controls that are commonly used but not included in the standard WPF toolkit. |
GitHub repositories (12)
Showing the top 5 popular GitHub repositories that depend on System.Speech:
Repository | Stars |
---|---|
hanmin0822/MisakaTranslator
御坂翻译器—Galgame/文字游戏/漫画多语种实时机翻工具
|
|
Danily07/Translumo
Advanced real-time screen translator for games, hardcoded subtitles in videos, static text and etc.
|
|
CommunityToolkit/Maui
The .NET MAUI Community Toolkit is a community-created library that contains .NET MAUI Extensions, Advanced UI/UX Controls, and Behaviors to help make your life as a .NET MAUI developer easier
|
|
ZGGSONG/STranslate
A ready-to-use, ready-to-go translation ocr tool developed by WPF/WPF 开发的一款即开即用、即用即走的翻译、OCR工具
|
|
microsoft/AdaptiveCards
A new way for developers to exchange card content in a common and consistent way.
|