Play a file and recognize a single word using the installed speech recognition engine. You must have a CSP enabled port in order to use this function
[Visual Basic] Overloads Public Shared Function PlayAndRecognizeWord( _ ByVal GrammerFile As String, _ ByVal chdev As Integer, _ ByVal source As Source, _ ByVal voice_format As VoiceFormat, _ ByVal buffer As Byte(), _ ByVal Fhandle As Integer, _ ByVal prompt As String, _ ByVal digmask As String, _ ByVal ClearDigitBuffer As Integer, _ ByVal EnableBargeIn As Integer, _ ByVal Timeout As Integer, _ ByVal error_file As String, _ ByRef RecognizedWord As String, _ ByRef Score As Integer _ ) As TermCode
The name of the recognition engine grammer file for this prompt. This contains the list of possible words that may be spoken and recognized. For example, this is an example of a Yes / No grammer file: #ABNF 1.0 UTF-8; language en-US; mode voice; tag-format lumenvox/1.0; root $Bool; $Yes = yes $GARBAGE|yep|yeah|sure|correct; $No = no $GARBAGE|nope; $Bool = $Yes {$="true";}|$No {$="false";}; For this parameter you would pass “ABNFBoolean.gram” of which the above would be contained. See LumenVox documentation for more information. You could also use a built in grammer an pass something like this in the string: "builtin:grammar/boolean"
chdev
The voice resource device
source
This parameter can be 1) CTI_FILE (0 defined in cti.h) which will play a file from disk from beginning to end, 2) CTI_VAP (1 defined in cti.h) which will play one or more prompts from a indexed voice file (.VAP). 3) CTI_MEMORY_VAP (2 defined in cti.h) which will play from an indexed voice file which has been loaded into memory, or 4) CTI_MEMORY (3 defined in cti.h) which will play a file from a memory location for a specified length. CTI_VAP_INDEX_IN_MEMORY (4 defined in cti.h) which will play prompts from the disk, but the VAP index has been loaded in memory by the application
voice_format
This defines the voice file type and sampling rate. Available options: Kbps64 2 //PCM 8Khz VOX format) 8000 b/s Wave8 5 //8Khz Wave 8000 bytes/sec Vox8Mulaw
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
prompt
This is a string list of prompts to be played out of a VAP file or memory VAP. It is not used if CTI_FILE or CTI_MEMORY was specified. It can contain one or more prompts that you wish spoken together. Each prompt should be separated by a comma. For example, if you wanted to say three phrased together, and the phrased were prompts 9, 2, and 56 respectively, then you would pass “9,2,56” to this parameter. New: If CTI_FILE is specified, you can pass the byte offset into the file to start the playing the recording. This way you can start playing in the middle of a file. On return, it will contain how many bytes were played. (Only if the length of the string passed in was greater than zero) If you need to know how many bytes were played, but you want to start playing from the beginning, send in a buffer that is 10 bytes big or so, and pass in “0”.
digmask
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
This is a TRUE or FALSE value. If true, any digits sitting in the board’s digit buffer are cleared before getting the new digits. Usually this is set to TRUE.
EnableBargeIn
0 – Disable the dialogic CSP BargeIn – start streaming to LumenVox as soon as the play starts. This option will require more LumenVox resources. 1 – Enable the dialogic CSP BargeIn – do not start streaming to the LumenVox until dialogic CSP detects user utterance. 2 – Enable the dialogic CSP BargeIn but do not allow a barge in until the whole file has played to completion. Then start streaming to LumenVox.
Timeout
How many seconds to wait for a valid response.
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
RecognizedWord
Returns the word from the grammer file that the user spoke.
Score
Returns a score 1 to 1000 of how closely of a match. The higher the better or more likely the user actually said the word returned.
Return Value
The terminating event. See TermCode enum for a list of terminating events. (i.e. TM_EOD if it returned because the file played to the end.