home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tolkit45.zip / os2tk45 / speech / h / smargs.h < prev    next >
Text File  |  1999-05-11  |  11KB  |  197 lines
  1. /*========================================================================*/
  2. /*                                                                        */
  3. /*  smargs.h                                                              */
  4. /*                                                                        */
  5. /*   (C) COPYRIGHT International Business Machines Corp. 1992,1996        */
  6. /*   All Rights Reserved                                                  */
  7. /*   Licensed Materials - Property of IBM                                 */
  8. /*   US Government Users Restricted Rights - Use, duplication or          */
  9. /*   disclosure restricted by GSA ADP Schedule Contract with IBM Corp.    */
  10. /*                                                                        */
  11. /*========================================================================*/
  12.  
  13. #ifndef SM_ARGS_H_INCLUDED
  14. #define SM_ARGS_H_INCLUDED
  15.  
  16. /*-------------------------------------------------------------------------*/
  17. /* Remember: - if you set arguments to the speech manager copies are held  */
  18. /*             in internal structures keeping the state of the speech      */
  19. /*             manager                                                     */
  20. /*           - if you query arguments you get read only values pointing    */
  21. /*             into state structure of the speech manager                  */
  22. /*             Be aware: DO NOT free these pointers                        */
  23. /*-------------------------------------------------------------------------*/
  24.  
  25. /*-------------------------------------------------------------------------*/
  26. /* system dependent speech manager definition for argument lists           */
  27. /*                                                                         */
  28. /* The typedef for SmArgVal has to be chosen such that                     */
  29. /*                                                                         */
  30. /*   sizeof (SmArgVal) >=    sizeof(char *)                                */
  31. /*                           sizeof(SmCallback *)                          */
  32. /*                           sizeof(SmLogger (*) ())                       */
  33. /*                                                                         */
  34. /*-------------------------------------------------------------------------*/
  35. typedef long SmArgVal;
  36.  
  37. typedef struct {
  38.  char      *name;                                 /* name of the argument  */
  39.  SmArgVal  value;                                 /* value of the argument */
  40. } SmArg;
  41.  
  42. /*-------------------------------------------------------------------------*/
  43. /* Macro to set the components of a SmArg structure                        */
  44. /*-------------------------------------------------------------------------*/
  45. #define SmSetArg(a, n, d)    ( (a).name = (n), (a).value = (long)(d) )
  46. #define SmSesSetArg(a, n, d) ( (a).name = (n), (a).value = (long)(d) )
  47.  
  48. /*-------------------------------------------------------------------------*/
  49. /* set the application name                                                */
  50. /*-------------------------------------------------------------------------*/
  51. #define SmNapplicationName             "applicationName"
  52.  
  53. /*-------------------------------------------------------------------------*/
  54. /* requested services                                                      */
  55. /*-------------------------------------------------------------------------*/
  56. #define SmNresetServices               "resetServices"
  57. #define SmNdatabase                    "database"
  58. #define SmNrecognize                   "recognize"
  59.  
  60. /*-------------------------------------------------------------------------*/
  61. /* option flags for the disconnection from the SmNrecognize service        */
  62. /*-------------------------------------------------------------------------*/
  63. #define SmNdiscardSessionData        "discardSessionData"
  64. #define SmNdiscardSessionAdaptation  "discardSessionAdaptation"
  65. #define SmNsaveSessionData           "saveSessionData"
  66. #define SmNsaveSessionAdaptation     "saveSessionAdaptation"
  67.  
  68. /*-------------------------------------------------------------------------*/
  69. /* option flags for the disconnection from the SmNenrollment service       */
  70. /*-------------------------------------------------------------------------*/
  71. #define SmNsuspendEnrollment         "suspendEnrollment"
  72. #define SmNcompleteEnrollment        "completeEnrollment"
  73.  
  74. /*-------------------------------------------------------------------------*/
  75. /* use the X eventhandler to dispatch incoming replies, the handler is     */
  76. /* accessed over the toplevel widget                                       */
  77. /*-------------------------------------------------------------------------*/
  78. #define SmNuseToplevelWidget           "useToplevelWidget"
  79.  
  80. /*-------------------------------------------------------------------------*/
  81. /* name constant used by pm applications to set the window id             */
  82. /*-------------------------------------------------------------------------*/
  83. #define SmNwindowHandle                "windowHandle"
  84.  
  85. /*-------------------------------------------------------------------------*/
  86. /* arguments to set the user                                               */
  87. /*-------------------------------------------------------------------------*/
  88. #define SmNuser                        "user"
  89. #define SmNuserId                      "userId"
  90. #define SmNenrollId                    "enrollId"
  91. #define SmNenrollIdDescription         "enrollIdDescription"
  92. #define SmNenrollDirectory             "enrollDirectory"
  93. #define SmNpassword                    "password"
  94. #define SmNtask                        "task"
  95. #define SmNconnectionId                "connectionId"
  96. #define SmNnavigator                   "navigator"
  97. #define SmNoverrideLock                "overrideLock"
  98.  
  99. /*-------------------------------------------------------------------------*/
  100. /* Callbacks for connection/disconnection to the Speech Manager            */
  101. /*-------------------------------------------------------------------------*/
  102. #define SmNconnectCallback             "connectCallback"
  103. #define SmNdisconnectCallback          "disconnectCallback"
  104.  
  105. /*-------------------------------------------------------------------------*/
  106. /* Callbacks for all other replies from the SM API                         */
  107. /*-------------------------------------------------------------------------*/
  108. #define SmNaddPronunciationCallback    "addPronunciationCallback"
  109. #define SmNaddToVocabCallback          "addToVocabCallback"
  110. #define SmNaudioLevelCallback          "audioLevelCallback"
  111.  
  112. #define SmNcancelPlaybackCallback      "cancelPlaybackCallback"
  113. #define SmNcorrectTextCallback         "correctTextCallback"
  114. #define SmNcorrectTextCancelCallback   "correctTextCancelCallback"
  115.  
  116. #define SmNdefineVocabCallback         "defineVocabCallback"
  117. #define SmNdisableVocabCallback        "disableVocabCallback"
  118. #define SmNdiscardDataCallback         "discardDataCallback"
  119.  
  120. #define SmNenableVocabCallback         "enableVocabCallback"
  121. #define SmNeventNotifyCallback         "eventNotifyCallback"
  122. #define SmNeventSynchCallback          "eventSynchCallback"
  123.  
  124.  
  125. #define SmNhaltRecognizerCallback      "haltRecognizerCallback"
  126.  
  127. #define SmNmicOffCallback              "micOffCallback"
  128. #define SmNmicOnCallback               "micOnCallback"
  129.  
  130. #define SmNrequestMicOffCallback       "requestMicOffCallback"
  131. #define SmNrequestMicOnCallback        "requestMicOnCallback"
  132. #define SmNmicOffRequestedCallback     "micOffRequestedCallback"
  133. #define SmNmicOnRequestedCallback      "micOnRequestedCallback"
  134.  
  135. #define SmNnewContextCallback          "newContextCallback"
  136.  
  137. #define SmNplayMessageCallback         "playMessageCallback"
  138. #define SmNplayMessageStatusCallback   "playMessageStatusCallback"
  139. #define SmNplayUtteranceCallback       "playUtteranceCallback"
  140. #define SmNplayUtteranceStatusCallback "playUtteranceStatusCallback"
  141. #define SmNplayWordsCallback           "playWordsCallback"
  142. #define SmNplayWordsStatusCallback     "playWordsStatusCallback"
  143.  
  144. #define SmNqueryAddedWordsCallback     "queryAddedWordsCallback"
  145. #define SmNqueryAlternatesCallback     "queryAlternatesCallback"
  146. #define SmNqueryCallback               "queryCallback"
  147. #define SmNqueryDefaultCallback        "queryDefaultCallback"
  148. #define SmNqueryEnabledVocabsCallback  "queryEnabledVocabsCallback"
  149. #define SmNqueryEnrollIdsCallback      "queryEnrollIdsCallback"
  150. #define SmNqueryLanguagesCallback      "queryLANGUAGESCallback"
  151. #define SmNqueryPronunciationsCallback "queryPronunciationsCallback"
  152. #define SmNqueryTasksCallback          "queryTasksCallback"
  153. #define SmNqueryUsersCallback          "queryUsersCallback"
  154. #define SmNqueryUserInfoCallback       "queryUserInfoCallback"
  155. #define SmNqueryVocabsCallback         "queryVocabsCallback"
  156. #define SmNqueryWordCallback           "queryWordCallback"
  157.  
  158. #define SmNremoveFromVocabCallback     "removeFromVocabCallback"
  159. #define SmNrecognizeNextWordCallback   "recognizeNextWordCallback"
  160. #define SmNrecognizedTextCallback      "recognizedTextCallback"
  161. #define SmNrecognizedWordCallback      "recognizedWordCallback"
  162. #define SmNrecognizedPhraseCallback    "recognizedPhraseCallback"
  163. #define SmNremovePronunciationCallback "removePronunciationCallback"
  164.  
  165. #define SmNsetCallback                 "setCallback"
  166. #define SmNsetDefaultCallback          "setDefaultCallback"
  167. #define SmNsetUserInfoCallback         "setUserInfoCallback"
  168.  
  169. #define SmNwordCorrectionCallback      "wordCorrectionCallback"
  170.  
  171. #define SmNundefineVocabCallback       "undefineVocabCallback"
  172. #define SmNutteranceCompletedCallback  "utteranceCompletedCallback"
  173. #define SmNreportEngineErrorCallback   "reportEngineErrorCallback"
  174. #define SmNqueryPronunciationCallback  "queryPronunciationCallback"
  175.  
  176. #define SmNcommandWordCallback         "commandWordCallback"
  177. #define SmNmicStateCallback            "micStateCallback"
  178. #define SmNfocusStateCallback          "focusStateCallback"
  179. #define SmNengineStateCallback         "engineStateCallback"
  180.  
  181. #define SmNrequestFocusCallback        "requestFocusCallback"
  182. #define SmNreleaseFocusCallback        "releaseFocusCallback"
  183. #define SmNfocusLostCallback           "focusLostCallback"
  184. #define SmNfocusGrantedCallback        "focusGrantedCallback"
  185.  
  186. #define SmNdefineGrammarCallback       "defineGrammarCallback"
  187.  
  188. #define SmNquerySessionsCallback       "querySessionsCallback"
  189. #define SmNdetachSessionsCallback      "detachSessionsCallback"
  190. #define SmNdetachRequestedCallback     "detachRequestedCallback"
  191.  
  192. #define SmNquerySpeechDataCallback     "querySpeechDataCallback"
  193. #define SmNsaveSpeechDataCallback      "saveSpeechDataCallback"
  194. #define SmNrestoreSpeechDataCallback   "restoreSpeechDataCallback"
  195.  
  196. #endif  /* SM_ARGS_H_INCLUDED */
  197.