SpeechHub Version 1.1.0, 1 July 2013
SpeechHub is compatible with Windows XP, Vista, Seven and Eight. At present in Windows, the NVDA screen reader and SpeakOn MediaSuite can use SpeechHub; more applications will follow in the future. You have to install SpeechHub only once no matter how many applications use it.
The computer resource requirements of SpeechHub itself are modest but the efficiency of the synthesizers connected to it vary considerably. The most efficient synthesizer is probably eSpeak and the most inefficient is MaryTTS; memory requirements with MaryTTS can reach 170Mb and CPU usage can reach over 80% in low power computers. Therefore your success in using SpeechHub will depend on the specification of your computer and the synthesizer you use.
The information below assumes that you have already installed SpeechHub if you need information about download and installation go to the
SpeechHub web site
It is also assumed that the purpose of SpeechHub is to be used with NVDA; once installed it can be used if desired automatically with SpeakOn MediaSuite as well.
To communicate with NVDA, SpeechHub is using an NVDA add-on which is supported by NVDA from version 2012.2. you need to install separately the NVDA SpeechHub add-on wich is included with this package as explained below otherwise it would not work!. If you have upgraded from an older version of SpeechHub make sure you install again the latest version of the NVDA SpeechHub add-on.
NVDA supports add-ons from version 2012.2 Previous versions of NVDA are not supported by SpeechHub.
The SpeechHub add-on speechhub.nvda-addon is placed in your computer when you install SpeechHub in:
On 32-bit computers:
C:\Program Files\SpeechHub\NVDAAddOn\speechhub.nvda-addon
On 64-bit computers:
C:\Program Files (x86)\SpeechHub\NVDAAddOn\speechhub.nvda-addon
In NVDA's versions 2012.2 and 2012.2.1 you could only install an add-on using the AddOn Manager. From version 2012.3 you can install an add-on directly from Windows Explorer which might be more convenient.
This method works only when NVDA is running otherwise you will get an error. Navigate to:
On 32-bit computers:
C:\Program Files\SpeechHub\NVDAAddOn\speechhub.nvda-addon
On 64-bit computers:
C:\Program Files (x86)\SpeechHub\NVDAAddOn\speechhub.nvda-addon
Make sure the focus is on speechhub.nvda-addon and press Enter. A dialog box is opened asking you if you wish to install the SpeechHub add-on; select OK to confirm. If you had a version of this add-on before you will be asked if you want to update it; select OK to confirm. You will be asked to restart NVDA to make sure your new add-on takes effect; select OK to confirm.
Once NVDA has restarted you can choose a SpeechHub synthesizer and voice in the usual way.
Follow the instructions below copied from NVDA's manual and in the open dialog box navigate to:
On 32-bit computers:
C:\Program Files\SpeechHub\NVDAAddOn\speechhub.nvda-addon
On 64-bit computers:
C:\Program Files (x86)\SpeechHub\NVDAAddOn\speechhub.nvda-addon
The AddOn Manager (From NVDA's manual for version 2012.2)
The AddOn Manager, accessed by selecting Manage add-ons under Tools in the NVDA menu, allows you to install and uninstall add-on packages for NVDA. These packages are provided by the community and contain custom code that may add or change features in NVDA or even provide support for extra Braille displays or speech synthesizers.
The AddOns Manager contains a list that displays all the add-ons currently installed in your NVDA user configuration. A package name, version and author are shown for each add-on, though further information such as a description and URL can be viewed by selecting the add-on and pressing the About add-on button.
To install an add-on, press the Install button. This will allow you to browse for an add-on package (.nvda-addon file) somewhere on your computer or on a network. Once you press Open, NVDA will ask if you really wish to install the add-on. As the functionality of add-ons is unrestricted inside NVDA, which in theory could include accessing your personal data or even the entire system if NVDA is an installed copy, it is very important to only install add-ons from sources you trust. Once the add-on is installed, NVDA must be restarted for the add-on to start running. Until you do, a status of "install" will show for that add-on in the list.
To remove an add-on, select the add-on from the list and press the Remove button. NVDA will ask if you really wish to do this. As with installing, NVDA must be restarted for the add-on to be fully removed. Until you do, a status of "remove" will be shown for that add-on in the list.
The Manager also has a Close button to close the dialog. If you have installed or removed add-ons, NVDA will first ask you if you wish to restart so that your changes can take effect.
Once NVDA has restarted you can choose a SpeechHub synthesizer and voice in the usual way.
SpeechHub runs as a socket server on your computer. This server is available only locally (known as localhost) which should not expose your computer to security risks but some firewall programs might ask you to confirm that you want to use it; you will need to confirm for SpeechHub to be usable. SpeechHub does not contact any resources outside your computer; it is simply communicating with its client applications such as the NVDA add-on or SpeakOn MediaSuite.
This version of SpeechHub can be used with the NVDA portable installation. You first need to install SpeechHub on your computer as mentioned above.
SpeechHub can only be installed in a USB type read write portable drive as it needs to write its settings to the drive. Assuming that NVDA is installed to drive 'F', perform the following steps and do not forget to install the SpeechHub add-on as explained in the last step below.
F:\Applications
Note that it is very important that you spell the folder name Applications exactly otherwise SpeechHub will not work.
From:
32-bit:
C:\Program Files\SpeechHub
64-bit:
C:\Program Files (x86)\SpeechHub
To:
F:\Applications
Resulting in:
F:\Applications\SpeechHub
SpeechHub needs Java to work. If you are sure that all the computers used with the portable drive have Java installed, there is no need for you to perform this step. Otherwise, for maximum portability, copy the Java folder to the portable drive. Make sure you copy the 32-bit version of Java as 32-bit Java can work with 64-bit computers but 64-bit Java cannot work with 32-bit computers. To ensure this, copy from:
32-bit:
C:\Program Files\Java
64-bit:
C:\Program Files (x86)\Java
To
F:\Applications
Resulting in:
F:\Applications\Java
Note that some computers have both Java 6 and Java 7 installed; you don't need both on your portable drive as SpeechHub can work with either.
Assuming that NVDA is installed in a folder called 'NVDA' on your portable drive, you probably start NVDA by changing folder to the NVDA folder and clicking (pressing Enter) on the nvda.exe file. You can still do this and SpeechHub should work fine. Alternatively you might find it convenient to start NVDA from a batch file located in the root of the portable drive. A batch file is provided for this purposes, copy:
From:
F:\Applications\SpeechHub\resources\Start_NVDA.bat
To:
F:\
Resulting in:
F:\Start_NVDA.bat
By clicking (pressing Enter) on this batch file, you can start NVDA. Note that if the folder where NVDA is located is called something else, you need to modify this batch file for it to work.
For SpeechHub to work in your portable installation, you must install the SpeechHub add-on. To do this start your portable version of NVDA. Bring up the Synthesizer dialog [Ctrl + NVDA + s] and make sure a non-SpeechHub synthesizer is selected; for example the native eSpeak driver. Save the NVDA configuration to make sure that when the portable NVDA version is started again, the native eSpeak driver is used. Note that this step is very important to make sure you don't lose speech during the SpeechHub add-on installation.
Once you have made sure that the eSpeak native driver is used, install the SpeechHub add-on in the usual way as explained in a previous page in this section from:
F:\Applications\SpeechHub\NVDAAddOn
If a previous version of the SpeechHub add-on exists, make sure it is replaced and that NVDA is restarted.