KeywordRecognizer.RecognizeOnceAsync(KeywordRecognitionModel) Method

Reference

Definition

Namespace:: Microsoft.CognitiveServices.Speech

Assembly:: Microsoft.CognitiveServices.Speech.csharp.dll

Package:: Microsoft.CognitiveServices.Speech v1.34.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Starts a keyword recognition session as an asynchronous operation.

public System.Threading.Tasks.Task<Microsoft.CognitiveServices.Speech.KeywordRecognitionResult> RecognizeOnceAsync (Microsoft.CognitiveServices.Speech.KeywordRecognitionModel model);

member this.RecognizeOnceAsync : Microsoft.CognitiveServices.Speech.KeywordRecognitionModel -> System.Threading.Tasks.Task<Microsoft.CognitiveServices.Speech.KeywordRecognitionResult>

Public Function RecognizeOnceAsync (model As KeywordRecognitionModel) As Task(Of KeywordRecognitionResult)

Parameters

model: KeywordRecognitionModel

The KeywordRecognitionModel that describes the keyword we want to detect.

Returns

Task<KeywordRecognitionResult>

A future that resolves to a KeywordRecognitionResult that resolves once a keyword is detected.

Remarks

The keyword recognition session lasts until the first keyword is recognized, or **StopRecognitionAsync** is called.

When a keyword is recognized, a Recognized event fires and the task completes. To detect another keyword, call the method again.

If no keyword is detected in the input, the task will never resolve unless StopRecognitionAsync() is called.

Applies to