Speech Recognition v2 - StartListening/StopListening

[VladislavAntonyuk]

Description of Change

StartListeningAsync is to start listening for speech. The method returns "immediately", it doesn't wait for the recognition result. I would not name it Background, to not confuse users, that it works like a background service and allows to spy for the user.
so flow for users:
StartListeningAsync
Subscribe for events (SpeechCompleted/PartialSpeech)
do some other stuff
Whenever I want, I can stop listening without caring for the result.

In future we can extend the API with Pause/Resume async

trying to replicate this API: https://learn.microsoft.com/en-us/uwp/api/windows.media.speechrecognition.speechcontinuousrecognitionsession.startasync?view=winrt-22621

Added new APIs :

• StartListeting
• StopListening
• SpeechToTextState
• SpeechRecognitionUpdated event
• SpeechRecognitionCompleted event

Removed:
Offline Speech Recognition on Windows. Maybe that is my pronunciation, but the output result is much worse than with online recognition.

Linked Issues

• Inspired by Some confused about speech to text #1210

PR Checklist

• Has a linked Issue, and the Issue has been approved(bug) or Championed (feature/proposal)
• Has tests (if omitted, state reason in description)
• Has samples (if omitted, state reason in description)
• Rebased on top of main at time of PR
• Changes adhere to coding standard
• Documentation created or updated: Update SpeechToText #1382 MicrosoftDocs/CommunityToolkit#315

Additional information

[pictos]

This looks good in general, just a friendly reminder this will be a breaking change since you're removing a feature on Windows. Also, I could see a lot of places where the CancellationToken provided by the user is being ignored, and this isn't ideal.

[brminnick]

Thanks Vlad!

Looks like we just need to add unit tests for the new public APIs and write the the docs.

Otherwise, the implementation looks good.

I made a couple tweaks:

• Added event ISpeechToText.StateChanged
• Renamed ISpeechToText.State -> ISpeechToText.CurrentState
• Renamed ISpeechToText.StartListeningAsync -> ISpeechToText.StartListenAsync
• Renamed ISpeechToText.StopListeningAsync -> ISpeechToText.StopListenAsync
• Renamed OnSpeechToTextRecognitionResultCompleted -> SpeechToTextRecognitionResultCompletedEventArgs
• Renamed OnSpeechToTextRecognitionResultUpdated -> SpeechToTextRecognitionResultUpdatedEventArgs
• Updated XML Comments for new APIs
• Updated Sample App to be more descriptive

[brminnick]

Adding the do not merge and pending documentation labels until we have the Docs PR opened

[VladislavAntonyuk]

Thank you @brminnick.
StateChanged event only makes sense on Android, where we manually switch the state, all other platforms have get-only property, that returns the real state of speech recognizer.

[brminnick]

@JoonghyunCho Hey Jay!

Could you incorporate the newly added event, ISpeechToText.StateChanged into the Tizen implementation?

We have a new method, void OnSpeechToTextStateChanged(SpeechToTextState), that you can call any time the SpeechToText state changes on Tizen.

Maui/src/CommunityToolkit.Maui.Core/Essentials/SpeechToText/SpeechToTextImplementation.shared.cs

Lines 83 to 86 in 7eda8ff

	void OnSpeechToTextStateChanged(SpeechToTextState speechToTextState)
	{
	speechToTextStateChangedWeakEventManager.HandleEvent(this, new SpeechToTextStateChangedEventArgs(speechToTextState), nameof(StateChanged));
	}

I'm not sure if Tizen has it's own event, like Windows' SpeechRecognizer.StateChanged event, that you can subscribe to, or if you'll need to call OnSpeechToTextStateChanged() manually, like we're doing for iOS, MacCatalyst and Windows.

[brminnick]

Thanks @VladislavAntonyuk! I think we're super close 💯

Once Jay implements StateChanged for Tizen, we should be ready to merge!

Re-requested review

[pictos]

Just found a couple of areas that we can improve and a question regarding an opened issue.

[JoonghyunCho]

Sorry I'm late!!!!! Just added StateChanged to Tizen :)

[JoonghyunCho]

Not sure why it suddenly cause the vulnerability error with the SkiaSharp. Can you guess anything?

Tizen implementation added

[VladislavAntonyuk]

Thank you @brminnick , @JoonghyunCho and @pictos !
@brminnick Can we merge a PR?

[brminnick]

For sure! I was just giving it a final look right now 🙌

#1398 is about to merge and then this one will be next