This guide describes how to obtain and install binary packages for the Yandex Speech Synthesis (SS) plugin to the UniMRCP server on Debian-based Linux distributions. The document is intended for system administrators and developers.
Instructions provided in this guide are applicable to the following versions.
UniMRCP 1.6.0 and above
UniMRCP Yandex SS Plugin 1.0.0 and above
UniMRCP RPMs are currently available for x86_64 (64-bit) architecture only.
|Operating System||Released||End of Support|
|Red Hat / Cent OS 7||November 2018||TBA|
|Red Hat / Cent OS 8||January 2021||TBA|
Packages for other distributions can be made available upon request.
UniMRCP binary packages are available to authenticated users only. In order to register a free account, please visit the following page.
A newly registered account needs to be verified by the user and then activated by the administrator prior further proceeding.
Account verification and activation.
The account credentials can be used to log in to the following websites.
Using the Yellowdog Updater, Modifier (yum), a command-line package management utility for Red Hat-based distributions, is recommended for installation of UniMRCP binary packages.
The content of a typical yum configuration file, to be placed in /etc/yum.repos.d/unimrcp.repo, is provided below.
[unimrcp] name=UniMRCP Packages for Red Hat / Cent OS-$releasever $basearch baseurl=https://username:email@example.com/repo/yum/main/rhel$releasever/$basearch/ enabled=1 sslverify=1 gpgcheck=1 gpgkey=https://unimrcp.org/keys/unimrcp-gpg-key.public [unimrcp-noarch] name=UniMRCP Packages for Red Hat / Cent OS-$releasever noarch baseurl=https://username:firstname.lastname@example.org/repo/yum/main/rhel$releasever/noarch/ enabled=1 sslverify=1 gpgcheck=1 gpgkey=https://unimrcp.org/keys/unimrcp-gpg-key.public
In order to verify that yum can properly connect and access the UniMRCP repository, the following command can be used.
yum repolist unimrcp yum repolist unimrcp-noarch
where unimrcp and unimrcp-noarch are names of the sections set in the yum configuration file above.
In order to retrieve a list of packages the UniMRCP repository provides, the following command can be used.
yum --disablerepo="*" --enablerepo="unimrcp" list available yum --disablerepo="*" --enablerepo="unimrcp-noarch" list available
In order to install the Yandex SS plugin, including all the dependencies, use the following command.
yum install unimrcp-yandex-ss
In order to install the additional data files for the sample client application umc, the following command can be used.
yum install umc-addons
This package is optional and provides additional data to be used for validation of basic setup.
UniMRCP RPM packages can be installed manually using the rpm utility. Note, however, that the system administrator should take care of package dependencies and install all the packages in appropriate order.
The RPM packages have the following naming convention:
packagename is the name of a package
universion is the UniMRCP version
packageversion is the RPM release version
rhelversion is the Red Hat version
arch is the architecture (x86_64, i686, …)
The following is a list of UniMRCP RPM packages required for the installation of the Yandex SS plugin.
|unimrcp-yandex-ss||Yandex SS plugin to the server.|
|unilibevent||UniMRCP edition of the libevent library.|
|umc-addons||Sample en-US data files used with umc. [Optional]|
|unilicnodegen||Node information retrieval tool, required for license deployment.|
|unimrcp-server||Shared library and application of the server.|
|unimrcp-client||Shared libraries and sample applications of the client. [Optional]|
|unimrcp-demo-plugins||Set of demo plugins to the server. [Optional]|
|unimrcp-common||Data common for the client and the server.|
|uniapr||UniMRCP edition of the Apache Portable Runtime (APR) library.|
|uniapr-util||UniMRCP edition of the Apache Portable Runtime Utility (APR-Util) library.|
|unisofia-sip||UniMRCP edition of the Sofia SIP library.|
Note that all the RPM packages provided by UniMRCP are signed by a GNU Privacy Guard (GPG) key. Before starting the installation, you may need to import the public key in order to allow the rpm utility to verify the packages.
rpm --import https://unimrcp.org/keys/unimrcp-gpg-key.public
Packages for APR, APR-Util and Sofia-SIP libraries must be installed first.
sudo dpkg --install uniapr_$aprversion-$distr_$arch.deb sudo dpkg --install uniapr-util_$apuversion-$distr_$arch.deb sudo dpkg --install unisofia-sip_$sofiaversion-$distr_$arch.deb
Then, a package containing common data for the client and the server, and a package for the server should follow.
sudo dpkg --install unimrcp-common_$universion-$distr_$arch.deb sudo dpkg --install unimrcp-server_$universion-$distr_$arch.deb
Next, a package containing the utility tool unilicnodegen, required for license deployment.
rpm -ivh unilicnodegen-$toolversion-$packageversion.el$rhelversion.$arch.rpm
Next, a package containing the libevent library.
rpm -ivh unilibevent-$libeventversion-$packageversion.el$rhelversion.$arch.rpm
Finally, a package containing the Yandex SS plugin should follow.
rpm -ivh unimrcp-yandex-ss-$universion-$packageversion.el$rhelversion.noarch.rpm
The Yandex SS plugin to the UniMRCP server is a licensed software.
In order to obtain a trial license, node information must be retrieved and submitted for license generation.
Use the installed tool unilicnodegen to retrieve the node information.
As a result, a text file uninode.info will be saved in the current directory.
Consider the following procedure to place an order.
- Navigate to https://unispeech.io/yss.
- Under the section Obtain License, select
- License Variation: Trial
- License Term: 30-day
- License Type: Node-bound
- License Quantity: 2
- Click Add to cart and then View cart.
- Click Proceed to checkout and then Place order.
- Attach the retrieved uninode.info file to the placed order.
Ther orders are normally processed within one business day. A license file will be provided as a result.
The license file needs to be placed into the directory /opt/unimrcp/data.
sudo cp umsyandexss_*.lic /opt/unimrcp/data
In order to utilize the Yandex SpeechKit API, corresponding service credentials need to be retrieved from the Yandex Cloud portal and further installed to the UniMRCP server.
Subscribe to the Yandex Text to Speech API.
Obtain your OAuth token.
- Log in to Yandex using your Yandex Passport account.
- Get an OAuth token from Yandex OAuth. To do this, follow the link, click Allow and copy the issued OAuth token.
Create a text file yandex.subscription.key in the directory /opt/unimrcp/data.
Store your OAuth token in the text file.
The provided OAuth token is used to obtain and periodically revalidate an IAM token.
In order to load the Yandex SS plugin into the UniMRCP server, open the file unimrcpserver.xml, located in the directory /opt/unimrcp/conf, and add the following entry under the XML element <plugin-factory>. Disable other synthesizer plugins, if available. The demo plugins for other resources can also be disabled.
<!-- Factory of plugins (MRCP engines) --> <plugin-factory> <engine id="Demo-Synth-1" name="demosynth" enable="false"/> <engine id="Yandex-SS-1" name="umsyandexss" enable="true"/> </plugin-factory>
In order to enable log output from the plugin and set filtering rules, open the configuration file logger.xml, located in the directory /opt/unimrcp/conf, and add the following entry under the element <sources>.
<source name="YANDEXSS-PLUGIN" priority="INFO" masking="NONE"/>
The configuration file of the plugin is located in /opt/unimrcp/conf/umsyandexss.xml. Default settings should be sufficient for the general use.
Validate your setup by using the sample UniMRCP client and server applications on the same host. The default configuration and data files should be sufficient for a basic test.
The Yandex SpeechKit folder identifier must be specified in the configuration file of the plugin, located in /opt/unimrcp/conf/umsyandexss.xml.
<synth-settings folder-id="****************" language="en-US" voice-name="" emotion="" auth-validation-period="3600" />
Start the UniMRCP server as a service.
systemctl start unimrcp
Check whether the plugin is normally loaded in the server logs, located in the directory /opt/unimrcp/log.
[INFO] Load Plugin [Yandex-SS-1] [/opt/unimrcp/plugin/umsyandexss.so]
Next, check for the license information.
[NOTICE] UniMRCP YandexSS License -product name: umsyandexss -product version: 1.0.0 -license owner: - -license type: trial -issue date: 2018-11-17 -exp date: 2018-12-17 -channel count: 2 -feature set: 0
The optional package umc-addons must be installed for this test to work.
Launch the sample UniMRCP client application umc.
cd /opt/unimrcp/bin ./umc
Run a typical speech synthesis scenario by issuing the command run bss2 from the console of the umc client application.
This command sends a SPEAK request to the server and then records synthesized stream into a PCM file stored in the directory /opt/unimrcp/var.
Visually inspect the log output for any possible warnings or errors.