# Application Programming Interface (API) Reference

# Index

A
- adding
- callback (75)
- pronunciation (80)
- words to a vocabulary (87)
- alphabets, retrieve (362)
- annotation
- annotations
- API
- closing connection (98)
- opening connection (172)
- version checking (90)
- application
- name retrieving (373)
- name, retrieving (380)
- archive
- retrieving name (519)
- argument
- attribute list (676)
- list (652)
- lists definition (675)
- pointer (655)
- setting (332)
- ASCII string
- retrieving (490)
- return code (496)
- attribute handling functions (41)
- attribute list (677)
- audio file, playing (180)
- audio functions (64)
- audio message name, retrieving (454)
- audio signal level, retrieving (385) C
- caddr_t data type (658)
- callback
- adding (77)
- dispatching (143)
- functions (44)
- removing (287)
- callbacks
- defined (640)
- handler function (662)
- listed (639)
- solicited (641), (645)
- unsolicited (642), (646), (648)
- cancelling
- personal language model update (108)
- playback (94)
- changing context (169)
- closing a connection (97)
- connecting to speech engine (101)
- connection functions (52)
- conserving disk space (133)
- context, new (170)
- controlling command recognition (277)
- conventions, naming (38)
- correcting misrecognized word (354) D
- data access functions (50), (355)
- data types
- caddr_t (657)
- SM_VOCWORD (666)
- SM_WORD (670)
- SmArg (649)
- SmArgVal (653)
- SmHandler (660)
- SmMsg (663)
- database functions (57)
- debug log (699)
- decoding audio (153)
- default values, setting (336)
- defining
- grammar, new (112)
- vocabulary, new (116)
- deleting a vocabulary (348)
- description of enrollment (390)
- detaching sessions (124)
- disabling a vocabulary (128)
- discarding
- audio data (130)
- error correction data (131)
- disconnecting
- from router (139)
- from speech engine (138)
- disk space, conserving (134)
- dispatch functions (45)
- dispatching callbacks (141)
- domain
- querying (247)
- retrieving (559), (562)
- dynamic
- grammar, defining (114)
- vocabulary, defining (120) E
- enabled vocabulary, querying (208)
- enabling vocabulary (145)
- engine state, retrieving (393)
- enrollment ID
- querying (214)
- retrieving (397)
- retrieving list of (403)
- retrieving status (545)
- enrollment scripts
- list of (391)
- retrieving (501)
- error handling functions (49)
- error message
- severity, retrieving (516)
- SMAPI (686)
- speech engine (701)
- establishing SMAPI connection (174)
- event
- notification (150)
- options (415)
- retrieving event ID (409)
- explanations, SMAPI message (696) F
- firm words, retrieving (419)
- focus
- releasing (283)
- requesting (302)
- state, retrieving (426)
- format, function call (35)
- function calls
- format of the descriptions (36)
- listed by group (40)
- naming conventions (37)
- overview (34)
- parallel session (70)
- to the engine (72)
- functions
- attribute handling (42)
- audio (65)
- callback (46)
- connection (53)
- data access (51), (356)
- database (58)
- dispatching (47)
- parallel session API calls (69)
- session (56)
- speech engine state (60)
- starter set (71)
- vocabulary (63) G
- grammar
- defining new (113) H
- halting
- recognition (157)
- speech engine (156) I
- IBM VoiceType
- ICSS API
- ICSSWord API
- ID
- enrollment (401), (406)
- event (412)
- retrieving (400)
- session (512)
- user (574), (578)
- infirm word (431)
- item value, retrieving (435) L
- language
- listing (440)
- querying (222)
- list of alphabets (361)
- log debug (697) M
- memory functions (48)
- message
- error (679)
- name, retrieving audio (453)
- playing (179)
- receiving (275)
- SMAPI (682)
- Speech Manager (691)
- spelling, retrieving (535)
- type (457)
- word count in, retrieving (468)
- message, retrieving spelling from (540)
- microphone
- state, retrieving (446)
- switching off (162), (306)
- switching on (166), (311) N
- name
- application, retrieving (376)
- value, retrieving (461)
- name, retrieving application (381)
- naming conventions (39)
- new context (168)
- notification
- audio event (152)
- word correction (351)
- number, retrieving utterance (589) O
- opening SMAPI (173)
- operator, SRCL P
- parallel session API calls (66)
- parameters
- querying (195)
- setting engine (328)
- percentages, processing complete (472)
- personal language model
- cancelling update (110)
- updating (105)
- playback, cancelling (95)
- playing
- message (177)
- utterance (183)
- words (188)
- pointer
- argument (656)
- character-aligned data (659)
- message (665)
- name, argument (506)
- pronunciation
- adding (82), (478)
- querying (225), (230)
- removing (299) Q
- querying
- added word (198)
- default values (206)
- domain list (250)
- enabled vocabulary (210)
- enrollment IDs, querying (217)
- information, user (256)
- languages available (220)
- list, user (261)
- pronunciation (227)
- pronunciations (232)
- sessions (238)
- specific word (271)
- speech data (244)
- speech engine parameters (194)
- tasks (249)
- user enrollment IDs (216)
- vocabulary (266) R
- receiving a message (273)
- recognition
- halting (158)
- sessions (239)
- recognizing next word (280)
- releasing speech focus (284)
- removing
- callback routine (289)
- pronunciation (297)
- words from vocabulary (292)
- reply message structures (638)
- reply messages
- solicited (636)
- structures (632)
- unsolicited (637)
- reply structure functions for unsolicited callbacks (647)
- requesting focus (303)
- restoring speech data (317)
- retrieving
- alternative words (365)
- annotations (370)
- application name (375)
- archive name (521)
- audio signal level (384)
- data archive, size of (527)
- description list (389)
- domain from reply structure (557), (564)
- engine state (395)
- enrollment ID (399)
- enrollment ID list (405)
- enrollment statuses (544)
- event ID (411)
- event options (417)
- firm words (421)
- focus state (424)
- grammar path name (429)
- infirm words, retrieving (433)
- item value (437)
- list of
- alphabets (360)
- enrollment scripts (500)
- languages (443)
- message word count (466)
- microphone state (448)
- name of audio message (451)
- name value (463)
- names of applications (379)
- options (524)
- phrase state flags (475)
- pointer to argument name (504)
- processing complete percentages (471)
- pronunciations (480)
- return code
- ASCII string (489), (622)
- SM_MSG, from (616)
- symbolic name (494), (628)
- session ID (509)
- severity, error message (515)
- SMAPI function return codes (483)
- speech data version (530)
- spelling from message (533), (539)
- status from reply structure (549)
- tags from reply structure (553)
- time values of spoken words (567)
- type of message (459)
- user ID from reply structure (571)
- user IDs from reply structure (577)
- users from reply structure (581)
- utterance number from reply structure (586)
- vocabulary
- list (593)
- name (599)
- words (605)
- words (610)
- return
- ASCII string for return code (624)
- SM_MSG return code (618)
- symbolic name of return code (630)
- return codes
- receiving SMAPI (485)
- SMAPI (680)
- Speech Manager (689)
- router
- callbacks (643)
- status (550)
- router.msg log (698) S
- saving speech data (323)
- session
- detaching (123)
- functions (55)
- ID, retrieving (511)
- parallel (68)
- querying (235)
- recognition (236)
- setting
- argument (331)
- default values (335)
- speech engine parameters (326)
- user information (342)
- signal, retrieving audio (386)
- SM_VOCWORD data type (667)
- SM_WORD data type (671)
- SmAddCallback (73)
- SmAddPronunciation (78)
- SmAddToVocab (83)
- SMAPI
- attributes (674)
- errors (688)
- message explanations (695)
- messages in numeric order (685)
- return codes in numeric order (684)
- SmApiVersionCheck (88)
- SmArg data type (650)
- SmArgVal data type (654)
- SmCancelPlayback (92)
- SmClose (96)
- SMCOMM.H, structure definitions (633)
- SmConnect (99)
- SmCorrectText (102)
- SmCorrectTextCancel (106)
- SmDefineGrammar (111)
- SmDefineVocab (115)
- SmDetachSessions (121)
- SmDisableVocab (125)
- SmDiscardData (129)
- SmDisconnect (135)
- SmDispatch (140)
- SmEnableVocab (144)
- SmEventNotify (148)
- SmGetAlphabets (357)
- SmGetAlternates (363)
- SmGetAnnotations (368)
- SmGetApplication (372)
- SmGetApplications (377)
- SmGetAudioLevel (382)
- SmGetDescriptions (387)
- SmGetEngineState (392)
- SmGetEnrollId (396)
- SmGetEnrollIds (402)
- SmGetEventId (407)
- SmGetEventOptions (413)
- SmGetFirmWords (418)
- SmGetFocusState (422)
- SmGetGrammarPath (427)
- SmGetInfirmWords (430)
- SmGetItemValue (434)
- SmGetLanguages (438)
- SmGetMicState (444)
- SmGetMsgName (449)
- SmGetMsgType (455)
- SmGetNameValue (460)
- SmGetNumberWordMsgs (464)
- SmGetPercentages (469)
- SmGetPhraseState (473)
- SmGetPronunciations (476)
- SmGetRc (481)
- SmGetRcDescription (486)
- SmGetRcName (491)
- SmGetScripts (497)
- SmGetService (502)
- SmGetSessionId (507)
- SmGetSeverity (513)
- SmGetSpeechDataArchive (517)
- SmGetSpeechDataOptions (522)
- SmGetSpeechDataSize (525)
- SmGetSpeechDataVersion (528)
- SmGetSpelling (531)
- SmGetSpellings (537)
- SmGetStates (542)
- SmGetStatus (547)
- SmGetTags (551)
- SmGetTask (555)
- SmGetTasks (560)
- SmGetTimes (565)
- SmGetUserId (569)
- SmGetUserIds (575)
- SmGetUsers (579)
- SmGetUtteranceNumber (584)
- SmGetVocabList (590)
- SmGetVocabName (596)
- SmGetVocWords (602)
- SmGetWords (608)
- SmHaltRecognizer (154)
- SmHandler data type (661)
- SmMicOff (159)
- SmMicOn (163)
- SmMsg data type (664)
- SmNewContext (167)
- SmOpen (171)
- SmPlayMessage (175)
- SmPlayUtterance (181)
- SmPlayWords (186)
- SmQuery (191)
- SmQueryAddedWords (196)
- SmQueryAlternates (201)
- SmQueryDefault (204)
- SmQueryEnabledVocabs (207)
- SmQueryEnrollIds (213)
- SmQueryLanguages (218)
- SmQueryPronunciation (223)
- SmQueryPronunciations (228)
- SmQuerySessions (233)
- SmQuerySpeechData (240)
- SmQueryTasks (245)
- SmQueryUserInfo (251)
- SmQueryUsers (257)
- SmQueryVocabs (262)
- SmQueryWord (267)
- SmReceiveMsg (272)
- SmRecognizeNextWord (276)
- SmReleaseFocus (281)
- SmRemoveCallback (285)
- SmRemoveFromVocab (290)
- SmRemovePronunciation (295)
- SmRequestFocus (300)
- SmRequestMicOff (304)
- SmRequestMicOn (309)
- SmRestoreSpeechData (314)
- SmReturnRc (613)
- SmReturnRcDescription (619)
- SmReturnRcName (625)
- SmSaveSpeechData (320)
- SmSet (324)
- SmSetArg (329)
- SmSetDefault (333)
- SmSetUserInfo (337)
- SmUndefineVocab (343)
- SmWordCorrection (349)
- solicited reply messages (634)
- speech argument list (651)
- speech data
- querying (242)
- restoring (316)
- saving (322)
- speech engine
- callbacks (644)
- connecting (100)
- conserving disk space (132)
- disconnecting (136)
- errors (700)
- halting (155)
- querying parameters (192)
- service requested (505)
- setting parameters (327)
- state functions (59)
- Speech Manager return codes and messages (692)
- spelling, retrieving from message (536), (541)
- SRCL syntax
- status
- codes and messages (693)
- enrollment, retrieving (546)
- symbolic name return code (495) T
- tags, retrieving (554)
- time values of spoken words, retrieving (568)
- turning
- off microphone (160), (308)
- on microphone (164), (313) U
- undefining a vocabulary (347)
- unsolicited reply messages (635)
- updating personal language model (103)
- user
- ID, retrieving (573)
- information
- querying (254)
- setting (340)
- querying (259)
- retrieving from reply structure (583)
- utterance
- number, retrieving (588)
- playing (185)
- resetting number (319) V
- version checking (91)
- vocabulary
- adding to (85)
- attribute, word (669)
- defining new (118)
- deleting (346)
- disabling (127)
- dynamic (119)
- enabling (147)
- functions (62)
- list, retrieving (595)
- name, retrieving (601)
- querying (264)
- querying enabled (212)
- undefining (345)
- words, retrieving (607) W
- word
- alternate (367)
- alternative (203)
- correction notification (353)
- playing (190)
- querying (269)
- querying added (200)
- recognizing next (279)
- removing from vocabulary (294)
- retrieving (612)
- word-attribute structure (672)

  [ Top of Page | Previous Page | Table of Contents | Index ]