Skip to main content

Demo Project

Note: RuntimeAudioImporter is required for this demo to obtain audio data as an example. Please download this plugin before using the demo (Fab).

In the Demo folder within the Content directory of the plugin, you will find assets created for demonstration purposes.

If you don't see the plugin's directory, please go to your Content Browser, reveal Settings in the top-right location, and enable Show Engine Content as well as Show Plugin Content. The project should be located in the Engine -> Plugins -> Runtime Speech Recognizer Content directory.

GitHub

These assets can be used to test and observe the example of the implementation of speech recognition. The project contains two examples: one for recognizing speech from a microphone and another for recognizing speech from a file. It also supports customization of recognition properties via the settings menu.

The project is implemented solely using Blueprints and UMG widgets, keeping it minimal. It supports UE 4.27 and later versions.

To test the project, simply open the RSR_Demo level located in the Demo folder and play it in the editor. This will add speech recognition-related widgets to your screen that you can interact with. You can also package the project for your target device (to set the RSR_Demo level as the default in your packaged project, select RSR_Demo as the Game Default Map in the project settings).

Short Description of the Project

The project begins with the RSR_Demo level, which adds a W_RSR_MainMenu widget to the viewport, which in turn serves as the main menu and creates the speech recognizer only once for the entire lifetime of the widget.

It also internally creates three widgets: W_RSR_SettingsMenu, W_RSR_FromMic, and W_RSR_FromFile, and passes the speech recognizer object reference to them for further operation.

W_RSR_SettingsMenu is used to modify recognition properties such as the number of used threads, language, step size, etc.

W_RSR_FromMic is used to recognize speech from the microphone. VAD is enabled by default.

W_RSR_FromFile is used to recognize speech from a file using a direct path.