class AsyncRecognizer

AsyncRecognizer abstract base class.

Members

SessionStarted

Syntax: public EventSignal< const SessionEventArgs & > SessionStarted;

Signal for events indicating the start of a recognition session (operation).

SessionStopped

Syntax: public EventSignal< const SessionEventArgs & > SessionStopped;

Signal for events indicating the end of a recognition session (operation).

SpeechStartDetected

Syntax: public EventSignal< const RecognitionEventArgs & > SpeechStartDetected;

Signal for events indicating the start of speech.

SpeechEndDetected

Syntax: public EventSignal< const RecognitionEventArgs & > SpeechEndDetected;

Signal for events indicating the end of speech.

Recognizing

Syntax: public EventSignal< const RecoEventArgs & > Recognizing;

Signal for events containing intermediate recognition results.

Recognized

Syntax: public EventSignal< const RecoEventArgs & > Recognized;

Signal for events containing final recognition results. (indicating a successful recognition attempt).

Canceled

Syntax: public EventSignal< const RecoCanceledEventArgs & > Canceled;

Signal for events containing canceled recognition results (indicating a recognition attempt that was canceled as a result or a direct cancellation request or, alternatively, a transport or protocol failure).

RecognizeOnceAsync

Syntax: public std::future< std::shared_ptr< RecoResult > > RecognizeOnceAsync ( );

Performs recognition in a non-blocking (asynchronous) mode.

Returns

Future containing result value (a shared pointer to RecoResult) of the asynchronous recognition.

StartContinuousRecognitionAsync

Syntax: public std::future< void > StartContinuousRecognitionAsync ( );

Asynchronously initiates continuous recognition operation.

Returns

An empty future.

StopContinuousRecognitionAsync

Syntax: public std::future< void > StopContinuousRecognitionAsync ( );

Asynchronously terminates ongoing continuous recognition operation.

Returns

An empty future.

StartKeywordRecognitionAsync

Syntax: public std::future< void > StartKeywordRecognitionAsync ( std::shared_ptr< KeywordRecognitionModel > model );

Asynchronously initiates keyword recognition operation.

Note: Keyword spotting (KWS) functionality might work with any microphone type, official KWS support, however, is currently limited to the microphone arrays found in the Azure Kinect DK hardware or the Speech Devices SDK.

Parameters

  • model The keyword recognition model that specifies the keyword to be recognized.

Returns

An asynchronous operation that starts the keyword recognition.

StopKeywordRecognitionAsync

Syntax: public std::future< void > StopKeywordRecognitionAsync ( );

Asynchronously terminates ongoing keyword recognition operation.

Note: Keyword spotting (KWS) functionality might work with any microphone type, official KWS support, however, is currently limited to the microphone arrays found in the Azure Kinect DK hardware or the Speech Devices SDK.

Returns

An empty future.