Toolbelt.Blazor.SpeechRecognition 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package Toolbelt.Blazor.SpeechRecognition --version 1.0.0                

                    
                

            
NuGet\Install-Package Toolbelt.Blazor.SpeechRecognition -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Toolbelt.Blazor.SpeechRecognition" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Toolbelt.Blazor.SpeechRecognition --version 1.0.0                

                    
                

            
#r "nuget: Toolbelt.Blazor.SpeechRecognition, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Toolbelt.Blazor.SpeechRecognition as a Cake Addin
#addin nuget:?package=Toolbelt.Blazor.SpeechRecognition&version=1.0.0

// Install Toolbelt.Blazor.SpeechRecognition as a Cake Tool
#tool nuget:?package=Toolbelt.Blazor.SpeechRecognition&version=1.0.0

Blazor Speech Recognition NuGet Package

Summary

This is a class library for Blazor app to provide Speech Recognition API access.

Requirements

Blazor v.6.0, 7.0, 8.0 or later.

Both "Blazor WebAssembly" and "Blazor Server" are supoorted.

Quick Start

1. Installation and Registration

Step.1-1 Install the library via NuGet package, like this.

> dotnet add package Toolbelt.Blazor.SpeechRecognition

Step.1-2 Register SpeechRecognition service into the DI container.

If the project is a Blazor Server App or a Blazor WebAssembly App ver.3.1 Preview 4 or earlyer, add the code into the ConfigureService method in the Startup class of your Blazor application.

// Program.cs

using Toolbelt.Blazor.Extensions.DependencyInjection; // <- Add this, and...
...
var builder = ...
...
builder.Services.AddSpeechRecognition(); // <- Add this line.
...

2. Usage in your Blazor component (.razor)

Step.2-1 Open the Toolbelt.Blazor.SpeechRecognition namespace, and inject the SpeechRecognition service into the component.

@{/* This is your component .razor */}
@using Toolbelt.Blazor.SpeechRecognition @{/* Add these two lines. */}
@inject SpeechRecognition SpeechRecognition
...

Step.2-2 Subscribe Result event of the SpeechRecognition service to receive the results of speech recognition.

protected override void OnInitialized()
{
  this.SpeechRecognition.Result += OnSpeechRecognized;
}

private void OnSpeechRecognized(object sender, SpeechRecognitionEventArgs args)
{
  // DO SOMETHING...
}

Step.2-3 Invoke StartAsync() method of the SpeechRecognition service when you want to start speech recognition.

private async Task OnClickStart()
{
  await this.SpeechRecognition.StartAsync();
}

Step.2-4 Implement IDisposable interface on the component, and unsubscribe Result event when the component is disposing.

...
@implements IDisposable
...
@code {
  ...
  public void Dispose()
  {
    this.SpeechRecognition.Result -= OnSpeechRecognized;
  }
}

See also sample code on the GitHub repository.

Configuration

The calling of services.AddSpeechRecognition() injects the references of JavaScript file (.js) - which is bundled with this package - into your page automatically.

If you don't want this behavior, you can disable these automatic injection, please call services.AddSpeechRecognition() with configuration action like this:

services.AddSpeechRecognition(options =>
{
  // If you don't want automatic injection of js file, add bellow;
  options.DisableClientScriptAutoInjection = true;
});

You can inject the helper JavaScript file manually. The URLs is bellow:

  • _content/Toolbelt.Blazor.SpeechRecognition/script.min.js

Release Note

Release notes is here.

License

Mozilla Public License Version 2.0

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 1,976 11/16/2023
0.0.5-alpha 122 11/12/2023
0.0.4.6-alpha 6,927 1/13/2020
0.0.3-alpha 281 9/6/2019
0.0.2.1-alpha 309 6/16/2019
0.0.1-alpha 386 5/2/2019

v.1.0.0
- Support to .NET 8 and IL trimming.


To see all the change logs, please visit the following URL.
- https://github.com/jsakamoto/Toolbelt.Blazor.SpeechRecognition/blob/master/RELEASE-NOTES.txt