This intelligently speaks a string of numbers. For example, “1234” would be spoken One thousand two hundred thirty-four. The VAP file name that you pass in must be in a compatible format. In other words, the voice segments must be in certain prompt #’s. For example, the word ONE would need to be in prompt #1. For information on what phrases need to be where, please see the "SYSTEM VAP FORMAT" appendix. The SYSTEM VAP file can either be on disk or in memory.
[Visual Basic] Overloads Public Shared Function PlayNumber( _ ByVal chdev As Integer, _ ByVal source As Source, _ ByVal voice_format As VoiceFormat, _ ByVal buffer As Byte(), _ ByVal Fhandle As Integer, _ ByVal str As String, _ ByVal format_spoken As String, _ ByVal TermDigits As String, _ ByVal ClearDigitBuffer As Integer, _ ByVal error_file As String _ ) As TermCode
This parameter can be 1) CTI_FILE which will play a file from disk from beginning to end, 2) CTI_VAP which will play one or more prompts from a indexed voice file (.VAP). 3) CTI_MEMORY_VAP which will play from an indexed voice file which has been loaded into memory, or 4) CTI_MEMORY which will play a file from a memory location for a specified length. CTI_VAP_INDEX_IN_MEMORY which will play prompts from the disk, but the VAP index has been loaded in memory by the application.
voice_format
The voice file format. (i.e. Wave11)
buffer
If the Source was CTI_MEMORY or CTI_MEMORY_VAP, this is a memory pointer to the base offset of the memory to be used. For CTI_VAP, this parameter is not used - the VAP file is expected to be open and a file handle is passed in the next parameter. If the Source is CTI_VAP_INDEX_IN_MEMORY, this parameter contains the memory pointer to the start of the VAP index that has been loaded into memory.
Fhandle
For CTI_VAP or CTI_VAP_INDEX_IN_MEMORY, this is the file handle to the open index file to use. For CTI_MEMORY, this contains the length of the file in memory to play. For CTI_FILE and CTI_MEMORY_VAP, this parameter is not used.
str
This contains the number that you want spoken.
format_spoken
This tells the system how you want the message to be spoken. The following summarize the 3 options: "0" – Speak the digits independently. For example, 1234 would be spoken "one", "two", "three", "four" "1" – Speak the number intelligently. The number 1234 would be spoken "one thousand two hundred thirty-for" "2" – Speak the number in dollars. The number 1234.23 would be spoken "one thousand two hundred thirty four dollars and twenty three cents"
TermDigits
This is a pointer to a string of digits that will terminate playing the file if pressed. Valid digits are 1-9 and the # and * key. For example, if you wished to terminate on the 1 key OR the # key, send the string "1#". If you pass the string "ANY", playing will be terminated upon any press of a key. Pass the empty string ("") if you wish for the file NOT to be interrupted.
ClearDigitBuffer
1 for TRUE or 0 for FALSE. If true, any digits sitting in the board's digit buffer are cleared before getting the new digits. Usually this is set to TRUE.
error_file
This is a full path to a file which speaks of a system error and a technical support number to call. This file must be a separate file and not part of a VAP file.