Reset
(VoiceTalk Module)
Description: | Immediately stops a speech stream and cancels any buffered speech. |
Returns: | Nothing |
Usage: | Script Only. |
Function Groups: | Speech and Sound |
Related to: | Configure | GetDevices | GetVoices | ShowLexicon | Speak | VoiceTalk |
Format: | VoiceTalkStream\Reset |
Parameters: |
VoiceTalkStream |
Required. A speech stream returned from VoiceTalk. |
Comments: | This function returns the error code resulting from issuing the command to the speech engine, or zero if no error was encountered. Issuing this command will immediately stop all speech for the stream on which it was issued. Other streams will be unaffected. Note that in the process of stopping the speech, a new speech request is issued, so the count of queued VoiceTalk\Speak requests will momentarily increase by one. |