Skip to content

Add CancellationToken explanation to SpeechToText docs #636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jfversluis merged 2 commits into from
Mar 17, 2026
Merged

Add CancellationToken explanation to SpeechToText docs #636

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26bf09d
Initial plan
Copilot Mar 17, 2026
a5ded68
docs: add CancellationToken explanation and fix undefined variable in…
Copilot Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/maui/essentials/speech-to-text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ Add permissions to `tizen-manifest.xml`:

The `SpeechToText` can be added to a .NET MAUI application in the following way.

> [!NOTE]
> The methods in this API accept a `CancellationToken` to cancel asynchronous operations. A `CancellationToken` can be obtained by creating a [`CancellationTokenSource`](/dotnet/api/system.threading.cancellationtokensource) and accessing its `.Token` property. You can also use `CancellationToken.None` if you don't need to cancel the operation. For more detail on how to provide a `CancellationToken` refer to the [Microsoft documentation](/dotnet/standard/threading/cancellation-in-managed-threads).

### Request permissions

Developers must manually request Permissions.Microphone and also call ISpeechToText.RequestPermissions():
Expand Down Expand Up @@ -197,6 +200,7 @@ Now you can inject the service like this:
public partial class MainPage : ContentPage
{
private readonly ISpeechToText speechToText;
private CancellationTokenSource? cancellationTokenSource;

public MainPage(ISpeechToText speechToText)
{
Expand All @@ -206,14 +210,17 @@ public partial class MainPage : ContentPage

public async void Listen(object sender, EventArgs args)
{
var isGranted = await speechToText.RequestPermissions(cancellationToken);
cancellationTokenSource?.Cancel();
cancellationTokenSource = new CancellationTokenSource();

var isGranted = await speechToText.RequestPermissions(cancellationTokenSource.Token);
if (!isGranted)
{
await Toast.Make("Permission not granted").Show(CancellationToken.None);
return;
}

await speechToText.StartListenAsync(new SpeechToTextOptions { Culture = CultureInfo.CurrentCulture, ShouldReportPartialResults = true }, CancellationToken.None);
await speechToText.StartListenAsync(new SpeechToTextOptions { Culture = CultureInfo.CurrentCulture, ShouldReportPartialResults = true }, cancellationTokenSource.Token);
}
}
```
Expand Down