Using the recognizer parameter function reference

This section provides an alphabetical reference to the recognizer parameter functions in the Universal Speech Access API . A typical function includes:

Prototype

The prototype is followed by a list of the function arguments. Data types include:

  • WORD (16-bit unsigned)

  • DWORD (32-bit unsigned)

  • INT16 (16-bit signed)

  • INT32 (32-bit signed)

  • BYTE (8-bit unsigned)

 

If a function argument is a data structure, the complete data structure is defined. Refer to Universal Speech Access API structures for more information.

Return values

The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS indicates the function was initiated; subsequent events indicate the status of the operation.

Refer to Universal Speech Access API errors for more information.

Events

If events are listed, the function is asynchronous and is complete when the DONE event is returned. If there are no events listed, the function is synchronous.

Additional information such as reason codes and return values may be provided in the value field of the event. Each event consists of an event ID, an event header value field, and the informational event buffer.

Refer to Universal Speech Access API events for more information.

Example

Example functions taken from sample application programs shipped with the product.

The notation /* ... */ indicates additional code that is not shown.