Skip to main content
Databiomes
Ctrl+K
LoginGet Started
HomeTrainingBrowserGame Engines

Getting Started

After installing the Ctrlvox package, a Ctrlvox settings scriptable object will be required. Create one from the menu, Tools > Databiomes > Ctrlvox > Setup to automatically generate the asset in the correct folder or create a Resources folder in you assets folder and use Assets > Create > Ctrlvox > Settings to create your own instance of the settings. Running 'Setup' will copy model files from the package into /Assets/StreamingAssets/Models/ctrlvox and Assets/StreamingAssets/Whisper, if setting up manually these model files must be added to the correct folders.

Ctrlvox will attach to an Audio Source Component on the same game object. To use Ctrlvox, simply add the Ctrlvox Manager Component to the game object, this will automatically add a Whisper Manager Component and Audio Source Component if they are not present.

For use with Vivox add a Vivox Channel Audio Tap Component and Ctrlvox Manager Component to the same game object.

Ctrlvox by default uses Whisper tiny. To replace the model, download the desired model from here, add the .bin file into Assets/StreamingAssets/Whisper and adjust the model path on the Whisper Manager Component to the new model.

Ctrlvox Manager has the event OnSegmentModerated that is raised when a segment of audio has been moderated by Ctrlvox. It provides the FloraOutput, which contains the output of the moderation, reaction (which is not used for Ctrlvox) and the tokenspeed for the inference, as well as the input text prompt (from Whisper ASR) to subscribers.

Settings​

Using the Ctrlvox settings scriptable object the targetted device can be changed. Currently CPU and AMD NPU is available for targetting. When changed the editor will prompt for a restart before the change will take effect.

Settings for Whisper can be adjusted on the Whisper Manager component. It is recommended to adjust the Step Sec and Length Sec under Streaming settings to the preferred values for your use case.

The Ctrlvox Manager component contains a setting for VAD Check Interval this value can be adjusted alongside Whisper settings to tweak the responsiveness of audio transcription.