Plays a prompt or message out the specified channel. The voice message can come from one of 4 sources. 1. Play an entire file from beginning to end. 2. Play specifed prompts from a single indexed voice file (VAP). 3. Play a message from memory. 4. Play prompts from a memory VAP (indexed voice file). 5. Play prompts from a file based VAP file with the index portion of the VAP loaded in memory. In addition to specifying the source of the file, you must specify the voice file format and speed. You must also specify the various ways the play may terminate.
[Visual Basic] Overloads Public Shared Function Play( _ ByVal chdev As Integer, _ ByVal source As Source, _ ByVal voice_format As VoiceFormat, _ ByVal buffer As Byte(), _ ByVal Fhandle As Integer, _ ByVal prompt_to_play As String, _ ByVal digmask 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
Voice format
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_to_play
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.
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
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.