[Speech] AivisSpeech integration

OneComme's Speech Voice can use AivisSpeech's speech synthesis engine.

AivisSpeech can be downloaded from the site below.

Caution

Version 1.0.0 or later is required to integrate with OneComme.
Each speech synthesis engine has its own license terms, so be sure to check AivisSpeech's terms of use carefully before using it.

AivisSpeech settings

The AivisSpeech app must be running to integrate with it.

① Connect via Integrations

Open Integrations from the menu in the top right of OneComme.

Open the "AivisSpeech" tab.

Check "Enable" to turn on the integration.

Once integrated, the list of Speech Voices will be displayed.
If it isn't, make sure AivisSpeech 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 the test 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," AivisSpeech is automatically selected as the default engine as soon as you enable the integration.

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

Open "Speech Settings" and choose AivisSpeech under "Default Text-To-Speech Engine" to use AivisSpeech for all streams. To use different engines per stream, choose AivisSpeech under "Text-To-Speech Engine" in "Individual options".

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

Note that if you disable an integration you had enabled, the Default Text-To-Speech Engine is automatically reselected from the remaining engines.

Settings


① Enable	Enable speech using AivisSpeech
② Auto Run	Launch AivisSpeech when OneComme starts *When auto-launched, it will also close automatically when OneComme quits
③ Executable File Path	Specify the AivisSpeech executable (*1)
④ Hostname	Hostname to connect to (usually no need to change)
⑤ Port	Port number of AivisSpeech's local HTTP server (usually no need to change)
⑥ Output Device	Choose the device that plays the Speech Voice If not selected, playback uses the default device
⑦ Speech Voice	The voice used for speech
⑧ Reload	Fetch the list of Speech Voices again
⑨ Speech Volume	Adjust the speech volume
⑩ Speech Speed	Adjust the speech speed
⑪ Speech Voice Pitch	Adjust the speech pitch
⑫ Intonation	Adjust the speech intonation
⑬ Taking A Breath	Adjust breathing pauses
⑭ Automatic Speed Adjustment	Automatically adjusts speech speed based on 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 piled up, so speech doesn't get backed up
⑱ Test Connection	Run a speech connection test

*1 - On Mac, you can auto-fill this using the steps below

Right-click the AivisSpeech app to open the menu
While the menu is open, hold down the option key
Select "Copy 'AivisSpeech' as Pathname"
Paste the copied path into the Executable File Path field for Auto Run

Specification --

While AivisSpeech is selected as the Text-To-Speech Engine, the settings in the red box shown 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 choose AivisSpeech under "Text-To-Speech Engine" in Individual options, you can override the Speech Voice and its settings for each stream.

For details, see "Individual options".