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`
	`protocol=default\|path_to_library`
	`configfile=default\|path_to_config file`
	`allvoice=y\|n`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `ip=server_ip_address` `[ports=1-60]`
	`[baseport=1024-65000] [share=y\|n]`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `voice=voice_name`
	`language=en-US\|en-GB\|fr-FR\|es-MX\|es-ES\|it-IT\|de-DE\|ja-JP`
	`gender=male\|female`
	`[voiceports=1-60] [voicebaseport=1024-65000] [voiceshare=y\|n]`

`tts change`	`defaultvoice=default voice name`
	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[protocol=default\|path_to_library]`
	`[configfile=default\|path_to_config file]`
	`[allvoice=y\|n]`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `[ip=server_ip_address] [ports=1-60]`
	`[baseport=1024-65000] [share=y\|n]`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `voice=voice_name`
	`[language=en-US\|en-GB\|fr-FR\|es-MX\|es-ES\|it-IT\|de-DE\|ja-JP]`
	`[gender=male\|female]`
	`[voiceports=1-60] [voicebaseport=1024-65000] [voiceshare=y\|n]`

`tts display`	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[server=name] [voice=voice_name]`

`tts unassign`	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[server=name] [voice=voice_name]`

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 protocol configfile allvoice	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
protocol	Library to be used	Default Specific path to different library
configfile	Configuration file used by the protocol	Default Specific path to the file
allvoice	Port supports all voices?	y\|n If y, the server ports, baseport, and share parameters must be specified. If n, the voice voiceports, voicebaseport, and voiceshare parameters must be specified.
server	DNS name for the server	Valid DNS name
ip	IP address of the server	Valid IP address
ports	The number of ports supported on the server	1-60 48 is the maximum for systems with NMS T1 cards or VoIP-only systems. 60 is the maximum for systems with NMS E1 cards. (Ideally, all port parameters combined do not exceed 48 for T1 systems and VoIP-only systems, or 60 for E1 systems.)
baseport	Starting port number	1024-65000
share	All ports use base port	y\|n (n means autoincrement)
voice	Voice name	valid voice name
language	Language of the voice	en-US\|en-GB\|fr-FR\|es-MX\|es-ES\|it-IT\|de-DE\|ja-JP
gender	Gender of the voice	male\|female
voiceports	Number of ports supported for this voice	1-60 48 is the maximum for systems with NMS T1 cards or VoIP-only systems. 60 is the maximum for systems with NMS E1 cards. (Ideally, all port parameters combined do not exceed 48 for T1 systems and VoIP-only systems, or 60 for E1 systems.)
voicebaseport	Starting port number	1024-65000
voiceshare	All ports use base port	y\|n (n means autoincrement)

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 assign with protocol and configfile is done before the defaultvoice assign has been done
The parameters from the four types of assigns are mixed. For example, you cannot assign the server parameter with the protocol parameter
If either protocol or configfile is set to default, both parameters must be set to default
The protocol is already assigned to another TTS type
The voice is already assigned to the TTS type and server
The ports, baseport, and share parameters are assigned to a server when the allvoice parameter is set to n
The ports, baseport, and share parameters are NOT assigned to a server when the allvoice parameter is set to y
The voiceports, voicebaseport, and voiceshare parameters are assigned to a voice when the allvoice parameter is set to y
The voiceports, voicebaseport, and voiceshare parameters are NOT assigned to a voice when the allvoice parameter is set to n

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 tts/server/voice
Any parameter value failed the field validation
The protocol or configfile is changed and at least one is changed to be default without the other one being set to default
The ports, baseport, and/or share parameters are specified when the allvoice parameter is set to n
If voiceports, voicebaseport, and/or voiceshare parameters are specified when the allvoice parameter is set to y

In addition, if the state of the allvoice parameter changes (from no to yes or from yes to no), a warning message is displayed if:

The allvoice parameter was no and is now changed to yes. All server administration associated with this ttstype needs to have ports, baseport, and share parameters administered.
If allvoice was yes and is now changed to no. All voice administration associated with this ttstype needs to have voiceports, voicebaseport, and voiceshare parameters administered.

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 Web Administration installation 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 protocol=default\|path to library configfile=default\|path to config file allvoice=y\|n command is executed
TTSproto.cfg	Configuration file	This file is installed with the Web Administration installation package

All of the tts configuration files that are created with the tts assign command and the TTSproto.cfg file are located in the /vs/sproxy/cfg directory.


`tts assign`	`defaultvoice=default_voice_name`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`protocol=default\|path_to_library`
	`configfile=default\|path_to_config file`
	`allvoice=y\|n`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `ip=server_ip_address` `[ports=1-60]`
	`[baseport=1024-65000] [share=y\|n]`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `voice=voice_name`
	`language=en-US\|en-GB\|fr-FR\|es-MX\|es-ES\|it-IT\|de-DE\|ja-JP`
	`gender=male\|female`
	`[voiceports=1-60] [voicebaseport=1024-65000] [voiceshare=y\|n]`

`tts change`	`defaultvoice=default voice name`
	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[protocol=default\|path_to_library]`
	`[configfile=default\|path_to_config file]`
	`[allvoice=y\|n]`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `[ip=server_ip_address] [ports=1-60]`
	`[baseport=1024-65000] [share=y\|n]`

	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`server=name` `voice=voice_name`
	`[language=en-US\|en-GB\|fr-FR\|es-MX\|es-ES\|it-IT\|de-DE\|ja-JP]`
	`[gender=male\|female]`
	`[voiceports=1-60] [voicebaseport=1024-65000] [voiceshare=y\|n]`

`tts display`	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[server=name] [voice=voice_name]`

`tts unassign`	`ttstype=TTS0\|TTS1\|TTS2\|TTS3\|TTS4\|TTS5\|TTS6\|TTS7\|TTS8\|TTS9`
	`[server=name] [voice=voice_name]`