tts command

Avaya Logo

tts command

This command allows users to assign, change, display, and unassign values to the Proxy Text-to-Speech (PTTS) configuration files.

Synopsis

`tts assign`	`defaultvoice=`<`default_voice_name`>

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`engine=sapi\|speechify\|realspeak\|mrcp`

	`When engine=sapi, use the following to assign a new server: ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=<name> ip=<server ip address> ports=1-<number of licensed ports>`

	`When engine=speechify, use the following to assign a new server: ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=<name> ip=<server ip address>`

	`When engine=mrcp and the server is an IBM WVS, use the following to assign a new server: ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=<name/media> ip=<server ip address>`

	`Use the following to assign a new voice to a server: server=<name> voice=<voice name> voiceports=1-<number of licensed ports> voicebaseport=1-65000`

	`For IBM WVS servers, the name must be specified as <name/media>. For MRCP servers (including IBM WVS), the baseport is typically set to 554.`

`tts change`	`defaultvoice=`<`default voice name`>
	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`engine=sapi\|speechify\|realspeak\|mrcp`

	`When engine=sapi, use the following to change a server: ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=<name> ip=<server ip address> ports=1-<number of licensed ports>`

	`When engine=speechify, use the following to change a server: ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=<name> ip=<server ip address>`

	`When engine=mrcp and the server is an IBM WVS, use the following to assign a new server: ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=<name/media> ip=<server ip address>`

	`Use the following to make a change to a voice: server=<name> voice=<voice name> voiceports=1-<number of licensed ports> voicebaseport=1-65000`
	`For IBM WVS servers, the name must be specified as <name/media>. For MRCP servers (including IBM WVS), the baseport is typically set to 554.`

`tts display`	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[server=`<`name`>`] [voice=`<`voice_name`>`]`
	`For IBM WVS servers, the name must be specified as <name/media>.`

`tts unassign`	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[server=`<`name`>`] [voice=`<`voice_name`>`]`
	`For IBM WVS servers, the name must be specified as <name/media>.`

Description

The tts assign command creates and populates configuration files with parameters. There are four types of assigns that can be done, and each type changes files as described in the following table:

Assign type (`tts assign`...)	File activity
`defaultvoice`	Also creates the TTS.cfg file. The `defaultvoice` parameter applies to all TTS types (ttstype).
`ttstype engine`	Also creates the TTS#.cfg file, where # is the ttstype number 0-9. This assign works only after the TTS.cfg file has been created by doing the `tts assign` with the `defaultvoice` parameter.
`ttstype server`	Modifies the TTS#.cfg file, where # is the ttstype number 0-9
`ttstype server voice`	Modifies the TTS#.cfg file, where # is the ttstype number 0-9

You can only enter one of the four types of assign commands at a time. The parameters from the four types of assign commands cannot be mixed. All parameter values are validated against the allowable parameter values. After a successful validation, all parameters are saved in the relevant configuration file.

The parameters for these commands are described in the following table:

Parameter	Description	Comments
`defaultvoice`	Default voice name if application does not provide a voice name	Valid voice name
`ttstype`	Text-to-Speech type	TTS0, TTS1, TTS2, TTS3, TTS4, TTS5, TTS6, TTS7, TTS8, TTS9
`engine`	Type of TTS engine	sapi\|speechify\|realspeak\|mrcp
`server`	DNS name for the server	Valid DNS name For IBM WVS servers, the name must be specified as <`name/media`>.
`ip`	IP address of the server or DNS name for the server	Valid IP address or DNS name
`ports`	The number of ports supported on a server with a sapi or mrcp engine	1-number of licensed ports
`baseport`	Starting port number	1-65000 For MRCP servers, the baseport is typically set to 554.
`voice`	Voice name	Valid voice name
`voiceports`	Number of ports supported for this voice	1-number of licensed ports
`voicebaseport`	Starting port number	1-65000

The tts assign command exits with an error message and the usage statement under the following circumstances:

Any required parameter is missing
Any parameter value failed the validation
The configuration file already exists in the case of assigning the defaultvoice or the ttstype with protocol and configfile
The server is already assigned to the TTS type
The parameters from the four types of assigns are mixed.
The voice is already assigned to the TTS type and server

The tts change command changes the specified configuration file parameter values for the specified tts type (ttstype), ttstype and server, or ttstype, server, and voice. It creates a backup configuration file. The change command exits with an error message and the usage statement if:

The configuration file does not exist for the ttstype or ttstype/server or ttstype/server/voice
Any parameter value failed the field validation

The tts display command displays the associated configuration file parameters for the specified ttstype, ttstype/server, or ttstype/server/voice. If the configuration file does not exist for the ttstype, the server does not exist for the ttstype, or the voice does not exist for the ttstype/server, the tts display command exits with an error message and the usage statement.

The tts unassign command deletes the configuration file – and the backup configuration file (if any) – for the specified ttstype, if a ttstype is entered as the only parameter. If a ttstype and server are entered, the server information is removed from the configuration file. If a ttstype, server, and voice are entered, the voice information is removed from the configuration file. If the configuration file does not exist for the ttstype, the server does not exist for the ttstype, or the voice does not exist for the ttstype/server, the unassign command exits with an error message and the usage statement.

After the successful execution of tts assign, tts change, and tts unassign commands, an informational message is displayed to advise you to stop and restart the voice system to activate the configuration file change.

Files

Two types of tts configuration files get created when a tts assign is done. The TTSproto.cfg configuration file is installed with the AVttsprxy package. The following table describes the files:

File	Description	Comments
TTS.cfg	Configuration file	This file is created when the `tts assign defaultvoice=default voice name` command is executed
ttstype.cfg	Configuration file	This file is created when the `tts assign ttstype=ttstype engine=sapi\|speechify\|realspeak\|mrcp` command is executed
TTSproto.cfg	Configuration file	This file is installed with the AVttsprxy package

All of the tts configuration files that are created with the tts assign command or installed with the AVttsprxy package are located in the /vs/sproxy/cfg directory.