README

What it does

The module can help you to make your website content more accessible. It synthesis text fields via the Google Text2Speech Api. Synthesis jobs are placed in a queue and processed one after the other. The text fields can be configured by selection or via SSML. Voice, language and speed are configured via JSON.

The module's queue supports LazyCron, but can also be triggered manually.

Features

Simple integration via the native file field.
Support SSML.
Direct synthesis via save action
Queue for many synthesis jobs
Process page for an overview of the queue

Install

Copy the files for this module to /site/modules/ProcessTextSynthesis/
In admin: Modules > Refresh. Install ProcessTextSynthesis.
Create a new file field of the type ‘TextSynthesis’.
Configure the text synthesis in the Input tab. More on this in the ‘Configuration’ section.

Install via composer

Execute the following command in your website root directory.
```
composer require nr/processtextsynthesis
```

Process view

Field configuration

Setup > Fields > my_synthesis_field

Switch to the Input tab to configure the field. You can use text mode and select the text fields to synthesise. The selected fields will appear in a row. In SSML mode, you can change the emphasis, speed or pitch of individual text fields. You can also add background noise or ambience (<par>). You can find out more about this in the SSML Example fieldset.

Here are all the supported markup tags for the Google Cloud API.

Request

Adjust voice, language and audio parameters such as pitch, encoding and sample rate. All setting options can be found in the request documentation. Note that in SSML mode you must define pitch and rate with an enclosing <prosody> tag.

<prosody rate="0.85" pitch="0.45">{my_field_name}</prosody>
<!-- default rate: 1, default pitch: 0.5 -->

Module configuration

Modules > Configure > ProcessTextSynthesis

API URL

Here you can customise the URL for the Google endpoint. The beta url is entered here by default.

API Key

Enter your API key here. If you do not yet have an API key, you can generate one in the Credentials area of the Google Cloud Console.

LazyCron (Cron)

The queue can be started via the LazyCron module. The module must be installed for this. After installation, the schedule and the jobs to be executed in parallel can be configured.

Alternatively, the queue can also be executed via a real cronjob and by calling the method ProcessTextSynthesis::runQueue(int $parallelJobs).

/** @var ProcessTextSynthesis $processTextSynthesis */
$processTextSynthesis = wire()->modules->get('ProcessTextSynthesis');
if($processTextSynthesis instanceof ProcessTextSynthesis) $processTextSynthesis->runQueue(1);
// runQueue() accepts the number of jobs to be executed in parallel as parameter

Should completed jobs be deleted?

Once a synthesis job has been completed, it can be deleted immediately or after the specified time if required.

The ProcessTextSynthesis::runMaintenance() method is then executed after ProcessTextSynthesis::runQueue().

Todos & Ideas

Add multilanguage support (my_synthesis_field, my_synthesis_field_fr, my_synthesis_field_de)
Pronunciation database ()

nr / processtextsynthesis

Maintainers

Details