2 DTK$
3 DTK$ANSWER_PHONE The Wait for Phone to Ring and Answer routine waits for the phone connected to the DECtalk device to ring and then answers it. Format: DTK$ANSWER_PHONE voice-id [,number-of-rings] [,text] [,timeout] Arguments: voice-id OpenVMS usage: identifier type: longw ord (unsigned) access: rea d only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. number-of-rings OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Number of rings DECtalk waits for before answering the phone. The optional number-of-rings argument is the address of a signed longword containing this number. The default is 1 ring. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text that DECtalk speaks after answering the phone. The optional text argument is the address of a descriptor pointing to the text. timeout OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Number of seconds that DECtalk allows the phone to ring before answering. The optional timeout argument is the address of a signed longword containing this timeout value. There is no default value. 3 DTK$CHECK_HDWR_STATUS The Check Hardware Status routine checks the DECtalk hardware for hardware malfunctions. Format: DTK$CHECK_HDWR_STATUS voice-id ,hdwr-status Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. hdwr-status OpenVMS usage: mask_longword type: longword (unsigned) access: write only mechanism: by reference Receives the hardware status of the DECtalk machine. The hdwr-status argument is the address of an unsigned longword bit mask that receives the status. 3 DTK$DIAL_PHONE The Dial the Telephone routine dials the specified number on the telephone. Format: DTK$DIAL_PHONE voice-id ,phone-number [,dial-mode] [,text] [,timeout] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk machine. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. phone-number OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Phone number to dial. The phone-number argument is the address of a descriptor pointing to the specified phone number. dial-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Mode to use when dialing the phone. The optional dial-mode argument is the address of an unsigned longword containing this mode. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text to be spoken after the phone is answered. The text argument is the address of a descriptor pointing to the specified text. timeout OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Number of seconds to wait for the phone to be answered. The optional timeout argument is the address of a signed longword containing this timeout value. If omitted, DECtalk dials the phone and then returns control to the calling program immediately. 3 DTK$HANGUP_PHONE The Hang Up the Phone routine speaks an optional message and then hangs up the phone. Format: DTK$HANGUP_PHONE voice-id [,text] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text to be spoken before hanging up the phone. The optional text argument is the address of a descriptor pointing to the specified text. 3 DTK$INITIALIZE The Initialize DECtalk routine initializes a DECtalk device and returns the device's assigned voice identifier. Format: DTK$INITIALIZE voice-id ,output-device [,device-type] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: write only mechanism: by reference Voice identifier of the newly created DECtalk device. The voice-id argument is the address of an unsigned longword that receives this identifier. output-device OpenVMS usage: device_name type: character string access: read only mechanism: by descriptor File specification or logical name to which the output associated with the DECtalk device is written. The output-device argument is the address of a descriptor pointing to this logical name. device-type OpenVMS usage: longword_signed type: longword (signed) access: write only mechanism: by reference Device type of the newly created DECtalk device. The optional device-type argument is the address of a signed longword that receives the device-type information. The two valid device types are: DTK$K_DTC_01 For DECtalk I. DTK$K_DTC_03 For DECtalk III. 3 DTK$LOAD_DICTIONARY The Load a Word into the DECtalk Dictionary routine loads a phonemic definition of a word into the DECtalk dictionary. Format: DTK$LOAD_DICTIONARY voice-id ,text ,substitution Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Word to be loaded into the DECtalk dictionary. The text argument is the address of a descriptor pointing to the specified word. substitution OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Phonemic definition of the word specified by the text argument. The substitution argument is the address of a descriptor pointing to the phonemic representation of the specified word. 3 DTK$READ_KEYSTROKE The Read a Key Entered on the Keypad routine reads a key entered on the phone keypad. Format: DTK$READ_KEYSTROKE voice-id ,key-code [,prompt-string] [,timeout] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. key-code OpenVMS usage: longword_signed type: longword (signed) access: write only mechanism: by reference The DTK$K_TRM_xxxx code for the key entered on the keypad. The key-code argument is the address of a signed longword that receives this code. The valid codes are listed in DTKDEF. prompt-string OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text to be spoken before waiting for input. The optional prompt-string argument is the address of a descriptor pointing to this text. timeout OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Number of seconds to wait for input. The optional timeout argument is the address of a signed longword containing the specified number of seconds the DECtalk device waits for input. If the timeout argument is omitted, DTK$READ_KEYSTROKE waits for input indefinitely. 3 DTK$READ_STRING The Read a Series of Keys Entered on the Keypad routine reads a series of keys entered on the phone keypad. Format: DTK$READ_STRING voice-id ,resultant-string [,prompt-string] [,timeout] [,longword-integer-termin-code] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. resultant-string OpenVMS usage: char_string type: character string access: write only mechanism: by descriptor String into which the keys being read are written. The resultant-string argument is the address of a descriptor pointing to this string. prompt-string OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text to be spoken before waiting for input. The optional prompt-string argument is the address of a descriptor pointing to this text. timeout OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Number of seconds DECtalk waits for input. The optional timeout argument is the address of a signed longword containing the number of seconds DECtalk waits for input. If the timeout argument is omitted, DTK$READ_STRING waits for input indefinitely. longword-integer-termin-code OpenVMS usage: longword_signed type: longword (signed) access: write only mechanism: by reference The DTK$K_TRM_xxxx code for terminating key entered. The optional longword-integer-termin-code argument is the address of a signed longword that receives this code. The valid codes are located in DTKDEF. 3 DTK$RETURN_LAST_INDEX The Return Last Index Spoken routine returns the last index spoken. Format: DTK$RETURN_LAST_INDEX voice-id ,p-index Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. p-index OpenVMS usage: longword_signed type: longword (signed) access: write only mechanism: by reference Index to be returned. The p-index argument is the address of a signed longword that receives the index identifier. 3 DTK$SET_INDEX The Insert an Index at the Current Position routine inserts an index into the current output stream. Format: DTK$SET_INDEX voice-id ,p-index Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. p-index OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Index to be inserted. The p-index argument is the address of a signed longword containing the index value. Valid values are in the range of 1 to 32767. An index of zero is reserved for use by DIGITAL. 3 DTK$SET_KEYPAD_MODE The Turn the Phone Keypad On and Off routine turns recognition of the telephone keypad on or off. Format: DTK$SET_KEYPAD_MODE voice-id ,keypad-mode Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. keypad-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Mode that determines the status of the telephone keypad. The keypad-mode argument is the address of an unsigned longword containing this mode. The valid mode specifiers are: DTK$K_KEYPAD_ON Turns the keypad on. DTK$K_KEYPAD_OFF Turns the keypad off. DTK$K_KEYPAD_AUTO Turns the keypad on with autostop. 3 DTK$SET_LOGGING_MODE The Set the Logging Mode for the Video Terminal Connected to the DECtalk Device routine controls the information that is displayed on the video terminal while the DECtalk device is functioning. Format: DTK$SET_LOGGING_MODE voice-id [,new-mode] [,old-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. new-mode OpenVMS usage: mask_longword type: longword (unsigned) access: read only mechanism: by reference DECtalk mode to be set. The optional new-mode argument is the address of a longword bit mask containing the specified mode. Valid values for new-mode are: o DTK$M_TEXT o DTK$M_PHONEME o DTK$M_RAWHOST o DTK$M_INHOST o DTK$M_OUTHOST o DTK$M_ERROR o DTK$M_TRACE o DTK$M_DEBUG old-mode OpenVMS usage: mask_longword type: longword (unsigned) access: write only mechanism: by reference Current mode settings of the DECtalk device. The optional old-mode argument is the address of a longword bit mask that receives the current DECtalk settings. 3 DTK$SET_MODE The Set the Mode for the DECtalk Terminal routine sets or resets the mode settings of the DECtalk terminal. Format: DTK$SET_MODE voice-id [,new-mode] [,old-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. new-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference DECtalk mode to be set. The optional new-mode argument is the address of a longword bit mask containing the specified mode. Valid values for new-mode are: o DTK$M_SQUARE o DTK$M_ASCII (valid for the DTC01 device only) o DTK$M_MINUS o DTK$M_EUROPE (valid for the DTC03 device only) o DTK$M_SPELL (valid for the DTC03 device only) old-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: write only mechanism: by reference Current mode settings of the DECtalk device. The optional old-mode argument is the address of a longword bit mask that receives the current DECtalk settings. 3 DTK$SET_SPEECH_MODE The Turn Speech Mode On and Off routine either starts or stops the DECtalk device's speech. Format: DTK$SET_SPEECH_MODE voice-id ,new-mode [,old-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. new-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Mode to be set. The new-mode argument is the address of an unsigned longword containing the specified mode. Valid values are: DTK$K_SPEAK Start speaking. DTK$K_STOP Stop speaking when current text is completed. DTK$K_HALT Stop speaking immediately. old-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: write only mechanism: by reference Current speech mode of the DECtalk device. The optional old-mode argument is the address of an unsigned longword that receives the current mode setting before enabling the new mode. The values returned in old-mode are the same as those valid for the new-mode argument. 3 DTK$SET_TERMINAL_MODE The Set the Mode for the Video Terminal Connected to the DECtalk Device routine controls the attributes of the video terminal connected to the DECtalk device. Format: DTK$SET_TERMINAL_MODE voice-id [,new-mode] [,old-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. new-mode OpenVMS usage: mask_longword type: longword (unsigned) access: read only mechanism: by reference DECtalk mode to be set. The optional new-mode argument is the address of a longword bit mask containing the specified mode. Valid values for new-mode are: o DTK$M_HOST o DTK$M_SPEAK o DTK$M_EDITED o DTK$M_HARD o DTK$M_SETUP o DTK$M_FILTER old-mode OpenVMS usage: mask_longword type: longword (unsigned) access: write only mechanism: by reference Current mode settings of the DECtalk device. The optional old-mode argument is the address of a longword bit mask that receives the current DECtalk settings. 3 DTK$SET_VOICE The Set Voice Characteristics routine changes the DECtalk voice characteristics to match those specified. Format: DTK$SET_VOICE voice-id [,new-voice] [,speech-rate] [,comma-pause] [,period-pause] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. new-voice OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Type of voice. The optional new-voice argument is the address of a signed longword containing any valid new-voice value. Valid values for new-voice are: DTK$K_VOICE_MALE Standard male voice DTK$K_VOICE_FEMALE Standard female voice DTK$K_VOICE_CHILD Standard child voice DTK$K_VOICE_DEEP_MALE Deep male voice DTK$K_VOICE_DEEP_FEMALE Deep female voice DTK$K_VOICE_OLDER_MALE Older male voice DTK$K_VOICE_LIGHT_FEMALE Light female voice speech-rate OpenVMS usage: longword_signed type: longword (signed) access: read only mechanism: by reference Rate at which DECtalk speaks, measured in words per minute. The optional speech-rate argument is the address of a signed longword containing this rate. The valid range of values for speech-rate is 120 to 350 words per minute. comma-pause OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Number of milliseconds by which to increase the time DECtalk pauses after a comma. The optional comma-pause argument is the address of a signed longword containing this number. A value of zero resets the pause time to the hardware default value. period-pause OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Number of milliseconds by which to increase the time DECtalk pauses after a period. The optional period-pause argument is the address of a signed longword containing this number. A value of zero resets the pause time to the hardware default value. 3 DTK$SPEAK_FILE The Speak the Text in a Specified File routine speaks the text contained in the specified file. Format: DTK$SPEAK_FILE voice-id ,filespec [,completion-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. filespec OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor File specification of the file containing the text to be spoken. The filespec argument is the address of a descriptor pointing to this file. completion-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Mode characteristic. The optional completion-mode argument is the address of an unsigned longword containing the specified mode. Valid values for the completion-mode argument are: DTK$K_IMMED Return to the user immediately (default). DTK$K_WAIT Wait until the text is completely spoken. DTK$K_STATUS Wait until the text is completely spoken, and then return a phone status. 3 DTK$SPEAK_PHONEMIC_TEXT The Speak the Specified Phonemic Text routine sends the specified phonemic text to the DECtalk device to be spoken. Format: DTK$SPEAK_PHONEMIC_TEXT voice-id ,text [,completion-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Phonemic text to be spoken. The text argument is the address of a descriptor pointing to the specified phonemic representation of the text. completion-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Mode characteristic. The optional completion-mode argument is the address of an unsigned longword containing the specified mode. Valid values for the completion-mode argument are: DTK$K_IMMED Return to the user immediately (default). DTK$K_WAIT Wait until the text is completely spoken. DTK$K_STATUS Wait until the text is completely spoken, and then return a phone status. 3 DTK$SPEAK_TEXT The Speak the Specified Text routine sends the specified text to the DECtalk device to be spoken. Format: DTK$SPEAK_TEXT voice-id ,text [,completion-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text to be spoken. The text argument is the address of a descriptor pointing to the specified text. completion-mode OpenVMS usage: longword_unsigned type: longword (unsigned) access: read only mechanism: by reference Mode characteristic. The optional completion-mode argument is the address of an unsigned longword containing the specified mode. Valid values for the completion-mode argument are: DTK$K_IMMED Return to the user immediately (default). DTK$K_WAIT Wait until the text is completely spoken. DTK$K_STATUS Wait until the text is completely spoken, and then return a phone status. 3 DTK$SPELL_TEXT The Spell Text routine causes DECtalk to pronounce each letter of the specified text. Format: DTK$SPELL_TEXT voice-id ,text [,completion-mode] Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine. text OpenVMS usage: char_string type: character string access: read only mechanism: by descriptor Text to be spelled out by DECtalk. The text argument is the address of a descriptor pointing to the specified string. completion-mode OpenVMS usage: mask_longword type: longword (unsigned) access: read only mechanism: by reference The optional completion mode characteristic. The completion-mode argument is the address of a longword bit mask containing the specified mode. Valid values for the completion-mode argument are: DTK$K_IMMED Return to the user immediately (default). DTK$K_WAIT Wait until the text is completely spoken. DTK$K_STATUS Wait until the text is completely spoken, and then return a phone status. 3 DTK$TERMINATE The Terminate DECtalk routine terminates the use of an initialized DECtalk. Format: DTK$TERMINATE voice-id Arguments: voice-id OpenVMS usage: identifier type: longword (unsigned) access: read only mechanism: by reference Voice identifier of the DECtalk device. The voice-id argument is the address of an unsigned longword containing this identifier. The voice identifier is returned by the DTK$INITIALIZE routine.