SPEAKit Guide
=============         

There is no formal documentation for SPEAKit yet. This file will
explain each of the functions in SPEAKit. If you have any 
questions about any of them, please email us at
SPEAKit@comm-unity.net

SPEAKit Functions:
------------------

SPEAK-Version

Returns the plug-in version. If you call this function with the
word "CONFIGURE", the Configuration Dialog Box will appear. If 
you call this function with the word "ABOUT", the Configuration
Dialog Box will appear with the "About" tab showing first.

Ex. External("SPEAK-Version", "")
      or
    External("SPEAK-Version", "CONFIGURE")
      or
    External("SPEAK-Version", "ABOUT")


SPEAK-Register

Registers the plug-in. It takes your First Name, Last Name, and
Registration Number separated by the pipe character ('|').

Ex. External("SPEAK-Register", "bob|jones|FF-FFFF-FFFF-FFF-FFF")


SPEAK-Speak

Speaks the text or field parameter.

Ex. External("SPEAK-Speak", "This is a test")
      or
    External("SPEAK-Speak", Speak_This_Field)


SPEAK-VoiceSelect

Selects the voice to use when speaking. The parameter can be a 
number or a string. If it is a number, it will select that voice
whose index into the voice array matches the number.  If it is a
string, it will attempt to match it against the Voice Name or 
Voice Speaker.  (See the Configuration Dialog Box.  The first 
three columns of the Voice List contain values that can be used 
in this function.)

Ex. External("SPEAK-VoiceSelect", "4") 
      or
    External("SPEAK-VoiceSelect", "Sam")


SPEAK-Speed

Sets the Word Per Minute speed of the speech. The range is from
30-510.  150-170 is normal, 30 is very slow, anything above 450
is incoherent. If you do not give a parameter, the current
speed setting is returned.

Note: Selecting a voice resets the speed to that voice's default
value.

Ex. External("SPEAK-Speed", "200")
      or
    External("SPEAK-Speed", "") <-- returns the current speed.


SPEAK-FileSpeak

Speaks the text file that is passed as the parameter.  

Ex. External("SPEAK-FileSpeak", "c:\My Documents\SpeakMe.txt")


SPEAK-PauseSpeech

Both Speak and FileSpeak above queue up the text to speak and return
immediately to FMP before the text is finished. Since this is true,
your FileMaker Script will most likely finish before the
Text-to-Speech Engine finishes speaking your text. 

You can use this function to temporarily pause that Speech. It takes
no parameter.

Ex. External("SPEAK-PauseSpeech", "")


SPEAK-ResumeSpeech

Both Speak and FileSpeak above cue up the text to speak and return
immediately to FMP, before the text is finished. Since this is true,
your FileMaker Script will most likely finish before the
Text-to-Speech Engine finishes speaking your text. 

You can use this function to resume any previously paused Speech. It
takes no parameter.

Ex. External("SPEAK-ResumeSpeech", "")


SPEAK-ResetSpeech

Both Speak and FileSpeak above cue up the text to speak and return
immediately to FMP, before the text is finished. Since this is true,
your FileMaker Script will most likely finish before the
Text-to-Speech Engine finishes speaking your text. 

You can use this function to stop and reset the Text-to-Speech 
Engine.  This will cancel any queued text. It takes no parameter.

Ex. External("SPEAK-ResetSpeech", "")
