osVoiceClearDictionary osVoiceClearDictionary (function)

Initializes Voice Recognition System word registration dictionary

Syntax

#include <ultra64.h> /* ultra64.h */

s32 osVoiceClearDictionary(OSVoiceHandle *hd, u8 words);

Description

The osVoiceClearDictionary function initializes the registered word dictionary for the Voice Recognition System. The dictionary is initialized so that the specified number of words can be registered in the dictionary. Words cannot be registered with the osVoiceSetWord before the dictionary is initialized with the osVoiceClearDictionary function.

hd is the Voice Recognition System control structure. The Voice Recognition System must be initialized with the osVoiceInit function before the osVoiceClearDictionary function is called. The number of words to be registered is specified in words. 1-255 words can be registered in the dictionary.

The returned value is an error code. A 0 (zero) is returned when processing ends normally. If an error occurs, this function has the following error codes.

CONT_ERR_NO_CONTROLLER

Nothing is connected to the controller port.

CONT_ERR_DEVICE

Something other than the Voice Recognition System is connected to the controller port.

CONT_ERR_VOICE_NO_RESPONSE

There was no response from the Voice Recognition System. There may be a problem with the hardware.

CONT_ERR_CONTRFAIL

There was a data transmission failure. There is a problem in the Voice Recognition System connection.

CONT_ERR_INVALID

There is an error in the function call method or in the argument. This error will not occur if the function is being used correctly.

See also

osVoiceCheckWord, osVoiceControlGain, osVoiceCountSyllables, osVoiceGetReadData, osVoiceInit, osVoiceMaskDictionary, osVoiceSetWord, osVoiceStartReadData, and osVoiceStopReadData

Revision History

1999/04/30 Changed Format