[Speech] VOICEVOX integration

You can have OneComme's Speech Voice generated by VOICEVOX's speech synthesis engine.

You can download VOICEVOX from the site below.

https://voicevox.hiroshiba.jp/

Caution

Version 0.20.0 or later is required to integrate with OneComme
Each speech synthesis engine has its own license, so make sure you fully check VOICEVOX's terms of use before using it

VOICEVOX settings

To integrate, the VOICEVOX app or VOICEVOX Engine must be running (engines other than VOICEVOX Engine are not supported)
Start the engine using the VOICEVOX app, or vv-engine/run in the VOICEVOX folder

① Connect via Integration

Open Integration from the menu at the top right of OneComme

Open the "VOICEVOX" tab

To integrate, check "Enable"

If the VOICEVOX integration succeeds, the Speech Voice list will be displayed
If it isn't, check that VOICEVOX is running, then click the reload button next to the Speech Voice selector to fetch it again

Select a voice and click "Test Connection" — if it reads text aloud, the connection is complete

② Select it as the Text-To-Speech Engine

If the Default Text-To-Speech Engine is still set to "Built-In Voice Engine", VOICEVOX will automatically be selected as the Default Text-To-Speech Engine as soon as you enable the integration

If another engine is already set as the default, it won't switch automatically, so select VOICEVOX using one of the methods below

Open "Speech Settings" and select VOICEVOX under "Default Text-To-Speech Engine" to use VOICEVOX for all streams
If you want to use different engines per stream, select VOICEVOX under "Text-To-Speech Engine" in "Individual options"

If VOICEVOX isn't selected as the engine anywhere, it won't be used for speech even if the integration is enabled

Also, if you disable an integration that was enabled, the Default Text-To-Speech Engine will automatically be reselected from the remaining engines

Settings


① Enable	Enable speech using VOICEVOX
② Auto Run	Starts VOICEVOX when OneComme starts If you don't need the GUI, we recommend setting the engine's executable file ※If auto-started, it will automatically close when OneComme closes
③ Executable File Path	Specify VOICEVOX's executable file (VOICEVOX.exe, run.exe, etc.) (※1)
④ Hostname	Hostname to connect to (usually no need to change)
⑤ Port	Port number of VOICEVOX's local HTTP server (usually no need to change)
⑥ Output Device	Select the device to play the Speech Voice on If not selected, it will play on the default device
⑦ Speech Voice	Voice used for speech
⑧ Refetch	Refetch the Speech Voice list from VOICEVOX
⑨ Speech Volume	Adjust speech volume
⑩ Speech Speed	Adjust speech speed
⑪ Speech Voice Pitch	Adjust speech pitch
⑫ Intonation	Adjust speech intonation
⑬ Taking A Breath	Adjust breathing during speech
⑭ Automatic Speed Adjustment	Automatically adjusts speech speed according to length
⑮ Acceleration Coefficient	Increases speed by the specified coefficient for every ⑯ characters
⑯ Accelerated Character Count	Increases speed for every specified number of characters
⑰ Maximum Queued Items	Automatically skips older items once the specified number has built up, to prevent speech from backing up too much
⑱ Test Connection	Run a speech connection test

※1 - On Mac, you can set this automatically using the steps below

Right-click the VOICEVOX app to open the menu
While the menu is open, hold down the option key
Select "Copy '"VOICEVOX"' as Pathname"
Paste the copied path into the Auto Run executable file path field

Specifications --

While VOICEVOX is selected as the Text-To-Speech Engine, the settings in the red box in the image below, under Settings > Speech (Built-In Voice Engine Settings), are not used

Settings such as whether to include the name in the spoken text (Syntax for speech) and character limits continue to work regardless of which engine is selected

Use the preview to check that everything works as expected

Per-stream speech settings

If you select VOICEVOX under "Text-To-Speech Engine" in Individual options, you can override the Speech Voice and settings for each stream

For details, see "Individual options"