Getting Started with Blazor SpeechToText in Blazor Web App
30 Jun 20267 minutes to read
This section briefly explains about how to include Blazor SpeechToText component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.
Prerequisites
Create a new Blazor Web App in Visual Studio
Create a Blazor Web App using Visual Studio via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Web App Getting Started documentation.
Prerequisites
Create a new Blazor Web App in Visual Studio Code
Create a Blazor Web App using Visual Studio Code via Microsoft Templates or the Syncfusion® Blazor Extension. For detailed instructions, refer to the Blazor Web App Getting Started documentation.
For example, in a Blazor Web App with the Auto interactive render mode, use the following commands in the integrated terminal (Ctrl+`):
dotnet new blazor -o BlazorWebApp -int Auto
cd BlazorWebApp
cd BlazorWebApp.ClientPrerequisites
Install the latest version of .NET SDK. If you previously installed the SDK, determine the installed version by executing the following command in a command prompt (Windows) or terminal (macOS) or command shell (Linux).
dotnet --versionCreate a Blazor Web App using .NET CLI
Run the following command to create a new Blazor Web App in a command prompt (Windows) or terminal (macOS) or command shell (Linux). For detailed instructions, refer to the Blazor Web App Getting Started documentation.
For example, in a Blazor Web App with the Auto interactive render mode, use the following commands:
dotnet new blazor -o BlazorWebApp -int Auto
cd BlazorWebApp
cd BlazorWebApp.ClientNOTE
Configure the appropriate Interactive render mode and Interactivity location while creating a Blazor Web App. For detailed information, refer to the interactive render mode documentation.
Install required Blazor packages
Install the Syncfusion.Blazor.Inputs NuGet package using one of the following methods.
Visual Studio (NuGet Package Manager):
- Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
- Search the required NuGet package (
Syncfusion.Blazor.Inputs) and install it.
Visual Studio Code or .NET CLI:
Open the terminal or command prompt and run the following command:
dotnet add package Syncfusion.Blazor.Inputs -v 34.1.29If using the WebAssembly or Auto render modes in the Blazor Web App, install this package in the client project.
NOTE
All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.
Add import namespaces
After the packages are installed, open the ~/_Imports.razor file in the client project and import the Syncfusion.Blazor and Syncfusion.Blazor.Inputs namespaces.
@using Syncfusion.Blazor
@using Syncfusion.Blazor.InputsRegister Blazor service
Register the Blazor service in the Program.cs file of your Blazor Web App.
....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....NOTE
If the Interactive Render Mode is set to
WebAssemblyorAuto, register the Blazor service in Program.cs files of both the server and client projects in your Blazor Web App.
Add script resources
The script can be accessed from NuGet through Static Web Assets. Include the script reference in the ~/Components/App.razor file.
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>NOTE
Check out the Adding Script Reference topic to learn different approaches for adding script references in your Blazor application.
Add Blazor SpeechToText component
- Open a Razor file located in the ~/Components/Pages (for example, Home.razor) and add the Blazor SpeechToText component inside the razor file.
- If the interactivity location is set to
Per page/componentin the Web App, define a render mode at the top of the razor file. (For example,InteractiveServer,InteractiveWebAssemblyorInteractiveAuto).
NOTE
If the Interactivity Location is set to
GlobalwithAutoorWebAssembly, the render mode is automatically configured in theApp.razorfile by default.
@rendermode InteractiveAuto
@using Syncfusion.Blazor.Inputs
<div class="speechtext-container">
<SfSpeechToText @bind-Transcript="@transcript"></SfSpeechToText>
<SfTextArea RowCount="5" ColumnCount="50" @bind-Value="@transcript" ResizeMode="Resize.None" Placeholder="Transcribed text will be shown here..."></SfTextArea>
</div>
<style>
.speechtext-container {
margin: 50px auto;
gap: 20px;
display: flex;
flex-direction: column;
align-items: center;
}
</style>
@code {
string transcript = "";
}Run the application
Visual Studio:
- Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. The Blazor SpeechToText component will render in your default web browser.
Visual Studio Code or .NET CLI:
- Open the terminal (Visual Studio Code) or command prompt (.NET CLI) and navigate to the
Clientproject folder. -
Run the following command:
dotnet run - The application will start and display in your default web browser.
The SpeechToText component requires an internet connection and using a browser that supports SpeechRecognition from the Web Speech API.
Adding button content
You can use the Text property to display the start listening text and StopStateText property to display the stop listening text by using the ButtonSettings property.
@using Syncfusion.Blazor.Inputs
<div class="speechtext-container">
<SfSpeechToText ButtonSettings="@buttonSettings" @bind-Transcript="@transcript"></SfSpeechToText>
<SfTextArea RowCount="5" ColumnCount="50" @bind-Value="@transcript" ResizeMode="Resize.None" Placeholder="Transcribed text will be shown here..."></SfTextArea>
</div>
<style>
.speechtext-container {
margin: 50px auto;
gap: 20px;
display: flex;
flex-direction: column;
align-items: center;
}
</style>
@code {
string transcript = "";
SpeechToTextButtonSettings buttonSettings = new SpeechToTextButtonSettings()
{
Text = "Start Listening", // Displays when idle
StopStateText = "Stop Listening" // Displays when speech recognition is active
};
}
