(Page 8 of 17 in this chapter)

ttsPreprocess

Description

Preprocesses text from text buffers using the English E-mail Preprocessor.

Prototype

DWORD ttsPreprocess(char* input_buffer,
TTS_METHOD method,
unsigned* result_size,
char* output_buffer,
unsigned output_bufsize)
input_buffer Pointer to the text input buffer.
method Preprocessing method.
TTS_METHOD_EMAIL_STRIP_HEADER
TTS_METHOD_EMAIL_KEEP_HEADER
result_size Pointer to length of text in the output
buffer after processing.
output_buffer Pointer to buffer for processed text.
out_bufsize Size of the output buffer.

Return Values

SUCCESSThe function has executed successfully.
CTAERR_BAD_ARGUMENTAt least one of the arguments contains an invalid value. Either the input_buffer, output_buffer, or result_size is null.
CTAERR_BAD_SIZEThe output buffer is not big enough to hold the preprocessed data.
TTSERR_INVALID_PREPROCESSOR_METHODThe specified preprocessing method is not valid.

Events

None.

Details

This function preprocesses English text buffers. The E-mail Preprocessor interprets text input by expanding acronyms, providing missing punctuation, and (optionally) stripping message headers.
Calls to ttsPreprocess specify an input buffer (where the text to be preprocessed resides) and an output buffer. Text from the output buffer can be spoken by sending the buffer to ttsSpeak.
Note: The size of the output buffer should be at least 4096 bytes. A CTAERR_BAD_SIZE message returns when the output buffer is not large enough.
NaturalText preprocessing functions are synchronous and run on the host machine, not on a Diva daughterboard. These functions work with English text only.
The two methods available for text preprocessing are:

TTS_METHOD_EMAIL_STRIP_HEADERThe E-mail Preprocessor removes message headers from text.
TTS_METHOD_EMAIL_KEEP_HEADER The E-mail Preprocessor does not remove message headers from text.

See Also

ttsPreprocessFile

(Page 8 of 17 in this chapter)

tech_support@nmss.com

Copyright © 1997, Natural MicroSystems, Inc. All rights reserved.