You are reading help file online using chmlib.com
|
You are reading help file online using chmlib.com
|
Microsoft Speech SDK
SAPI 5.1
The Microsoft Speech SDK setup is built on the Windows Installer technology. The SAPI 5.1 core components are only available for distribution through Windows Installer merge modules and are called .msm files. These .msm files should be included in an applications setup and packaged in a Microsoft Installer .msi file. The .msi files consume the merge modules and handle the actual installation process. All other application-specific installation files should be included in this module. The .msi is run by the setup.exe file. The setup.exe file determines if the Windows Installer is present on your system and installs it if necessary. SAPI 5.1 is redistributable by independent software vendors (ISVs) or individuals by including the Speech SDK MSMs in their setup process and using the Windows Installer merge module technologies.
The following topics are covered in this section:
In order to ensure that SAPI 4.0 and SAPI 5.1 can coexist on a single machine, the following four steps have been taken:
There is one known issue: SAPI 4.0 and SAPI 5.1 cannot share a common microphone. If one version of SAPI has control of the microphone, the other cannot use it. However, the functionality of TTS is not affected.
The engines that will be shipped with the Microsoft Speech SDK are shown below:
| Engine | Language |
|---|---|
| SR | English |
| Japanese | |
| Chinese | |
| TTS | English |
| Chinese |
The Speech SDK setup will produce merge modules for use with MSI to support the following configurations:
If the number of localized languages increases, separate msms for each language will be made available. It is recommended to include all localized msm's in 3rd party Setups so that if the user wants to install on Japanese or Chinese systems will be correctly localized.
This module has a dependency on sp5.msm.
This module has a dependency on sp5.msm and sp5intl.msm
This module has a dependency on sp5sr.msm, sp5intl.msm and sp5.msm.
This module has a dependency on sp5sr.msm, sp5intl.msm and sp5.msm.
This module has a dependency on sp5.msm and sp5intl.msm.
The Speech SDK samples and help documentation for SAPI 5.1 API/DDI will be included in the installation.
Setup will verify the versions of the various installed components. Setup will detect if the operating system one of the following:
When attempting to install the Microsoft Speech SDK on a non-supported operating system, a dialog box will appear with the string "SAPI5 is currently not supported on this Operating System. You must upgrade to Windows 98 or higher." After the Speech SDK has been installed on your computer, the footprint will not be deleted from the drive. If you accidentally delete the sapi.dll and then tries to run one of the applications, then the footprint file will be able to get the sapi.dll file and install it. All engine files should follow the 8.3 naming convention.
NOTE: To obtain the Chinese (Simplified) and Japanese Microsoft SR Engines and the Chinese (SImplified) TTS engine, please install the Microsoft Speech SDK 5.1 Language Pack.
Microsoft SR Engine
The SR engines may be installed on any drive on a user's computer. The SR engine is language independent (i.e., the same engine is loaded with different data to create a different language engine). As a result, the SR engine files by default should be located in a language independent path, as follows: program files\common files\speechengines\Microsoft\sr
The SR data files contain the language specific information. The SR data files (including the files needed for command and control (C and C) and ITN) should be located in the following path: program files\common files\speechengines\Microsoft\sr\<LCID> where the <LCID> is 1033 (English), 2052 (Chinese (simplified)) and 1041 (Japanese)
Microsoft TTS Engine
The Microsoft Speech SDK contains a number of samples and tools. These samples should be located in the following directories:
| Name | Path |
|---|---|
| Dictation Pad | \Microsoft Speech SDK 5.1\samples\cpp\dictpad |
| Simple Dictation | \Microsoft Speech SDK 5.1\samples\cpp\simpledict |
| TTSApp | \Microsoft Speech SDK 5.1\samples\cpp\TTSApp |
| Tutorial - Coffee S0 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS0 |
| Tutorial - Coffee S1 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS1 |
| Tutorial - Coffee S2 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS2 |
| Tutorial - Coffee S3 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS3 |
| Tutorial - Coffee S4 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS4 |
| Tutorial - Coffee S5 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS5 |
| Tutorial - Coffee S6 | \Microsoft Speech SDK 5.1\samples\cpp\tutorials\CoffeeS6 |
| Talkback | \Microsoft Speech SDK 5.1\samples\cpp\talkback |
| Telephony Application | \Microsoft Speech SDK 5.1\samples\cpp\telephony |
| SR Engine (Null engine) | \Microsoft Speech SDK 5.1\samples\cpp\engines\SR |
| TTS engine (Null engine) | \Microsoft Speech SDK 5.1\samples\cpp\engines\TTS |
| SPComp | \Microsoft Speech SDK 5.1\bin |
| SRComp | \Microsoft Speech SDK 5.1\tools\comp\SR |
| TTSComp | \Microsoft Speech SDK 5.1\tools\comp\TTS |
| Grammar Editor | \Microsoft Speech SDK 5.1\bin |
| SimpleAudioDll | \Microsoft Speech SDK 5.1\Samples\CPP\SimpleAudioDll |
| TapiCustomStream | \Microsoft Speech SDK 5.1\Samples\CPP\TapiCustomStream |
| ListBoxCSharp | \Microsoft Speech SDK 5.1\Samples\CSharp\Listbox |
| SimpleTTSCSharp | \Microsoft Speech SDK 5.1\Samples\CSharp\SimpleTTS |
| SimpleTTSJScript | \Microsoft Speech SDK 5.1\Samples\Scripts\SimpleTTS |
| AudioApp | \Microsoft Speech SDK 5.1\Samples\VB\AudioApp |
| ListboxVB | \Microsoft Speech SDK 5.1\Samples\VB\ListboxVB |
| RecoVB | \Microsoft Speech SDK 5.1\Samples\VB\RecoVB |
| SimpleDictVB | \Microsoft Speech SDK 5.1\Samples\VB\SimpleDict |
| SimpleTTSVB | \Microsoft Speech SDK 5.1\Samples\VB\SimpleTTS |
| TTSAppVB | \Microsoft Speech SDK 5.1\Samples\VB\TTSAppVB |
| VBTapiSample | \Microsoft Speech SDK 5.1\Samples\VB\VBTAPISamples |
| Mkvoice | \Microsoft Speech SDK 5.1\samples\cpp\engines\TTS\mkVoice |
The command used for quite install is "msiexec /i "Microsoft Speech SDK 5.1.msi" /qn". "setup.exe /S /v/qn" is also another usable option.
For engine specific registry settings, please see the Object Tokens and Registry Settings white paper. All registry keys will be manually created and deleted upon installation and uninstallation respectively. This means that nothing in the setup procedure that will use self registration. Microsoft will not handle the lazy initialization for the user profiles.
Setup is not able to know about the individuals who will be using speech features after installation. The lazy registration information will continue to be built up by sapi.dll at run time.
The easiest way to build a Setup package that incorporates the SAPI 5.1 redistributable merge modules is to use a Setup tool that is designed specifically for the Windows Installer technology. Currently a number of these exist on the market including, but not limited to: Install Shield for Windows Installer, Visual Studio Installer, Wise for Windows Installer, and Seagate WinINSTALL. These tools can consume the SAPI 5.1 merge modules (.msm's) and seamlessly install the components along with the rest your setup. Simply consult the documentation on these products or follow the built in Wizards to build your Setup package and include the SAPI 5.1 .msm's.
If these tools are not available, consider downloading the Windows Installer SDK and building your Setup package manually. The following steps provide a walk through on how this is done.
For example, if you have a TTS application (YourTTSApp.exe) that you want to install along with the SAPI 5.1 merge modules, simply determine the source and destination locations of your application.
| File | Path To Source | Path To Target |
|---|---|---|
| YourTTSApp.exe | C:\YourApp\YourTTSApp.exe | D:\Program Files\CompanyName\YourTTSApp.exe |
Directory Table
Component Table
File Table
Media Table
Feature Table
Feature Components Table
Registry Table
ShortCut Table
Icon Table
Property Table
InstallExecuteSequence Table
InstallUISequence Table
AdminExecuteSequence Table
AdminUISequence Table
AdvtExecuteSequence Table
For details on specific table values and entries, see the "Windows Installer Examples / An installation example" section of the Msi.chm help file that is included in the Windows Installer SDK.
| Summary Information Property | Data | Notes |
|---|---|---|
| Template (Platform and Language) | ;1033 | Platform and language used by the database. Leaving the platform field empty indicates the package is platform independent. The ProductLanguage property from the database is typically used for this summary property. The sample's Language ID indicates that the package uses U.S. English. |
| Revision Number (Package Code) | {49D185A1-D7FD-11D2-9159-00C04FD70856} | This is the package code GUID that uniquely identifies the sample package. If you reproduce this sample, use a utility such as GUIDGEN to generate a different GUID for your package. The results of GUIDGEN contain lowercase characters, note that you must change all lowercase characters to uppercase for a valid package code. See Package and Product Codes. |
| Page Count (Minimum Installer Version) | 100 | For Windows Installer version 1.0, this property should be set to the integer 100. |
| Word Count (Type of Source) | ;1033 | Platform and language used by the database. Leaving the platform field empty indicates the package is platform independent. The ProductLanguage property from the database is typically used for this summary property. The sample's Language ID indicates that the package uses U.S. English. |
The remaining summary information stream properties are not required, but should be set for yourProduct.msi.
| Summary Information Property | Data | Notes |
|---|---|---|
| Title | Installation Database | Informs users that this database is for an installation rather than a transform or a patch. |
| Subject | yourProduct | File browsers can display this as the product to be installed with this database. |
| Keywords | Installer, MSI, Database | File browsers that are capable of keyword searching can search for these words. |
| Author | Your Company Name | Name of the product's manufacturer. |
| Comments | This installer database contains the logic and data required to install YourProduct. | Informs the user about the purpose of this database. |
| Creating Application | Orca | Application used to create the installation database. |
| Security | 0 | The sample database is unrestricted read-write. |
To use MsiInfo to add the summary information to the sample, change to the directory containing the database yourProduct.msi and use the following command line:
MsiInfo.exe yourProduct.msi -T "Installation Database" -J Subject -A "Your Company Name" -K "Installer, MSI, Database" -O "This installer database contains the logic and data required to install YourProduct." -P ;1033 -V {49D185A1-D7FD-11D2-9159-00C04FD70856} -G 100 -W 0 -N Orca -U 0
| Property | Value |
|---|---|
| DefaultUIFont | DlgFont8 |
| INSTALLLEVEL | 3 |
| LIMITUI | 1 |
| Manufacturer | Your Company Name |
| ProductCode | {19BED231-30AB-11D3-91D3-00C04FD70856} |
| ProductLanguage | 1033 |
| ProductName | yourProduct |
| ProductVersion | 01.20.0000t |
| UpgradeCode | {ACFBE060-33B8-11D3-91D6-00C04FD70856} |
You are reading help file online using chmlib.com
|
Back to top