(Page 2 of 17 in this chapter)


4.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the functions available through the NaturalText API. Each function follows the format shown below (any sections irrelevant to a particular function are omitted):

Example: ttsDoSomething

Description

A brief description of the function.

Prototype

An example function, with datatypes, place holders, and brief explanations of arguments provided.

Return Values

A list of any values that this function can return, with brief descriptions.

Events

A list of any events and reason fields are associated with this function with brief descriptions.

Details

Additional information about using this function, and about the way it behaves.

See Also

Cross-references to other functions in the NaturalText API.

4.1.1 Asynchronous Functions and DONE Events

CT Access DONE events inform applications when asynchronous functions have completed processing.

Calls to ttsSpeak return done events when they complete successfully. Applications should examine the value field in these events for reason or error codes.

Note: A call to ttsSpeak can return SUCCESS to the application when the command is initiated, but fail later on. When this happens, the TTS_SPEAK_DONE event contains an error in its value field.



(Page 2 of 17 in this chapter)


tech_support@nmss.com
Copyright © 1997, Natural MicroSystems, Inc. All rights reserved.