interface MAGES::Experimental::EmbodimentJARIA::ISpeechToTextHandler¶

Overview¶

Interface for handling speech recognition. More…

interface ISpeechToTextHandler
{
    // properties

    Agent TheAgent;
    bool SpeechRecognized;
    string TextDuringRecognition;
    bool WaitingForInput;
    string RecognizedUserInput;

    // events

    event UserInputRecorded();
    event Recognizing();

    // methods

    Task StartSpeechRecognitionAsync();
    void ResetRecognizedInput();
    Task StopSpeechRecognitionAsync();
    void Startup();
    void ClearAllEvents();
};

// direct descendants

class AzureSpeechHandler;

Detailed Documentation¶

Interface for handling speech recognition.

Properties¶

Agent TheAgent

Gets or sets the Agent script.

bool SpeechRecognized

Gets a value indicating whether the user input has been recognized.

string TextDuringRecognition

Gets or sets the text during recognition.

bool WaitingForInput

Gets or sets a value indicating whether the handler is waiting for input.

string RecognizedUserInput

Gets or sets the recognized user input.

Events¶

event UserInputRecorded()

Event that is triggered when user input is recorded.

event Recognizing()

Event that is triggered when the recognizer is recognizing.

Methods¶

Task StartSpeechRecognitionAsync()

Starts the speech recognition.

Returns:

The executing task.

void ResetRecognizedInput()

Resets the user’s recognized input.

Task StopSpeechRecognitionAsync()

Stops the speech recognition.

Returns:

The executing task.

void Startup()

Starts up the speech handler.

void ClearAllEvents()

Clears listeners from events.