fsay

Avaya Logo

fsay

The fsay instruction plays ASCII text stored in a file.

Synopsis

fsay(ctype.src)

Description

The fsay instruction is similar to the say instruction, however it instructs the system to speak ASCII text stored in a file instead of a buffer.

The ctype.src argument specifies the fully qualified or relative pathname of a file of ASCII text to be spoken. The script may pass the pathname as a literally quoted string, or the contents of a null-terminated field. The maximum length of the pathname is 128 characters. There is no limit to the size of the file itself.

The tflush instruction may be used to flush the TTS speech and cause the text to be spoken. The first two arguments to tflush, the must_hear_flag and the wait_indicator, have the same effect for text-to-speech as for coded speech. The third argument to tflush, the remember_flag, is not used for TTS. That is, the first argument may be used to disable talkoff and the second may be used to play speech and to continue the script without waiting for the play to complete. Normally, TSM waits for a TTS play to complete before going on to the next instruction.

The fsay instruction returns one of the following values in script register 0 (r.0).

Return value	Description
0	The fsay instruction completed successfully
-1	The fsay instruction failed to queue the request
-2	One of the following has occurred: The length of the full pathname passed the fsay instruction was too large A relative pathname was passed in and the setfalk instruction was not previously called to set the prepend directory A relative pathname was passed in and the length of the prepend directory plus the length of the relative pathname was too large