include/sapiaut.idl

   1 /*
   2  * Copyright (C) 2019 Alistair Leslie-Hughes
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18 #if 0
  19 #pragma makedep install
  20 #endif
  21
  22 import "oaidl.idl";
  23 import "ocidl.idl";
  24
  25 interface ISpeechAudioFormat;
  26 interface ISpeechGrammarRule;
  27 interface ISpeechGrammarRuleState;
  28 interface ISpeechObjectTokens;
  29 interface ISpeechPhraseProperties;
  30 interface ISpeechPhraseRule;
  31 interface ISpeechRecognizer;
  32 interface ISpeechRecoContext;
  33 interface ISpeechRecoGrammar;
  34 interface ISpeechRecoResult;
  35
  36 typedef long SpeechLanguageId;
  37
  38 typedef enum SpeechLoadOption
  39 {
  40     SLOStatic  = SPLO_STATIC,
  41     SLODynamic = SPLO_DYNAMIC
  42 } SpeechLoadOption;
  43
  44 typedef enum SpeechRuleState
  45 {
  46     SGDSInactive            = SPRS_INACTIVE,
  47     SGDSActive              = SPRS_ACTIVE,
  48     SGDSActiveWithAutoPause = SPRS_ACTIVE_WITH_AUTO_PAUSE,
  49     SGDSActiveUserDelimited = SPRS_ACTIVE_USER_DELIMITED
  50 } SpeechRuleState;
  51
  52 typedef enum SpeechTokenShellFolder
  53 {
  54     STSF_AppData         = 0x001a,
  55     STSF_LocalAppData    = 0x001c,
  56     STSF_CommonAppData   = 0x0023,
  57     STSF_FlagCreate      = 0x8000
  58 } SpeechTokenShellFolder;
  59
  60 typedef enum SpeechEngineConfidence
  61 {
  62     SECLowConfidence    = -1,
  63     SECNormalConfidence =  0,
  64     SECHighConfidence   =  1
  65 } SpeechEngineConfidence;
  66
  67 typedef enum SpeechAudioState
  68 {
  69     SASClosed = SPAS_CLOSED,
  70     SASStop   = SPAS_STOP,
  71     SASPause  = SPAS_PAUSE,
  72     SASRun    = SPAS_RUN
  73 } SpeechAudioState;
  74
  75 typedef enum SpeechRunState
  76 {
  77     SRSEDone       = SPRS_DONE,
  78     SRSEIsSpeaking = SPRS_IS_SPEAKING
  79 } SpeechRunState;
  80
  81 typedef enum SpeechDiscardType
  82 {
  83     SDTProperty      = SPDF_PROPERTY,
  84     SDTReplacement   = SPDF_REPLACEMENT,
  85     SDTRule          = SPDF_RULE,
  86     SDTDisplayText   = SPDF_DISPLAYTEXT,
  87     SDTLexicalForm   = SPDF_LEXICALFORM,
  88     SDTPronunciation = SPDF_PRONUNCIATION,
  89     SDTAudio         = SPDF_AUDIO,
  90     SDTAlternates    = SPDF_ALTERNATES,
  91     SDTAll           = SPDF_ALL
  92 } SpeechDiscardType;
  93
  94 typedef enum SpeechRecognizerState
  95 {
  96     SRSInactive          = SPRST_INACTIVE,
  97     SRSActive            = SPRST_ACTIVE,
  98     SRSActiveAlways      = SPRST_ACTIVE_ALWAYS,
  99     SRSInactiveWithPurge = SPRST_INACTIVE_WITH_PURGE,
 100 } SpeechRecognizerState;
 101
 102 typedef enum SpeechDisplayAttributes
 103 {
 104     SDA_No_Trailing_Space      = 0,
 105     SDA_One_Trailing_Space     = SPAF_ONE_TRAILING_SPACE,
 106     SDA_Two_Trailing_Spaces    = SPAF_TWO_TRAILING_SPACES,
 107     SDA_Consume_Leading_Spaces = SPAF_CONSUME_LEADING_SPACES
 108 } SpeechDisplayAttributes;
 109
 110 typedef enum SpeechFormatType
 111 {
 112     SFTInput    = SPWF_INPUT,
 113     SFTSREngine = SPWF_SRENGINE
 114 } SpeechFormatType;
 115
 116 typedef enum SpeechGrammarState
 117 {
 118     SGSEnabled   = SPGS_ENABLED,
 119     SGSDisabled  = SPGS_DISABLED,
 120     SGSExclusive = SPGS_EXCLUSIVE,
 121 } SpeechGrammarState;
 122
 123 typedef enum SpeechRuleAttributes
 124 {
 125     SRATopLevel        = SPRAF_TopLevel,
 126     SRADefaultToActive = SPRAF_Active,
 127     SRAExport          = SPRAF_Export,
 128     SRAImport          = SPRAF_Import,
 129     SRAInterpreter     = SPRAF_Interpreter,
 130     SRADynamic         = SPRAF_Dynamic,
 131     SRARoot            = SPRAF_Root
 132 } SpeechRuleAttributes;
 133
 134 typedef enum SpeechWordPronounceable
 135 {
 136     SWPUnknownWordUnpronounceable = SPWP_UNKNOWN_WORD_UNPRONOUNCEABLE,
 137     SWPUnknownWordPronounceable   = SPWP_UNKNOWN_WORD_PRONOUNCEABLE,
 138     SWPKnownWordPronounceable     = SPWP_KNOWN_WORD_PRONOUNCEABLE
 139 } SpeechWordPronounceable;
 140
 141 typedef enum SpeechSpecialTransitionType
 142 {
 143     SSTTWildcard = 1,
 144     SSTTDictation,
 145     SSTTTextBuffer
 146 } SpeechSpecialTransitionType;
 147
 148 typedef [hidden] enum DISPID_SpeechRecoContext
 149 {
 150     DISPID_SRCRecognizer                         = 1,
 151     DISPID_SRCAudioInInterferenceStatus,
 152     DISPID_SRCRequestedUIType,
 153     DISPID_SRCVoice,
 154     DISPID_SRAllowVoiceFormatMatchingOnNextSet,
 155     DISPID_SRCVoicePurgeEvent,
 156     DISPID_SRCEventInterests,
 157     DISPID_SRCCmdMaxAlternates,
 158     DISPID_SRCState,
 159     DISPID_SRCRetainedAudio,
 160     DISPID_SRCRetainedAudioFormat,
 161     DISPID_SRCPause,
 162     DISPID_SRCResume,
 163     DISPID_SRCCreateGrammar,
 164     DISPID_SRCCreateResultFromMemory,
 165     DISPID_SRCBookmark,
 166     DISPID_SRCSetAdaptationData
 167 } DISPID_SpeechRecoContext;
 168
 169 typedef [hidden] enum DISPID_SpeechDataKey
 170 {
 171     DISPID_SDKSetBinaryValue = 1,
 172     DISPID_SDKGetBinaryValue,
 173     DISPID_SDKSetStringValue,
 174     DISPID_SDKGetStringValue,
 175     DISPID_SDKSetLongValue,
 176     DISPID_SDKGetlongValue,
 177     DISPID_SDKOpenKey,
 178     DISPID_SDKCreateKey,
 179     DISPID_SDKDeleteKey,
 180     DISPID_SDKDeleteValue,
 181     DISPID_SDKEnumKeys,
 182     DISPID_SDKEnumValues
 183 } DISPID_SpeechDataKey;
 184
 185 typedef [hidden] enum DISPIDSPRG
 186 {
 187     DISPID_SRGId = 1,
 188     DISPID_SRGRecoContext,
 189     DISPID_SRGState,
 190     DISPID_SRGRules,
 191     DISPID_SRGReset,
 192     DISPID_SRGCommit,
 193     DISPID_SRGCmdLoadFromFile,
 194     DISPID_SRGCmdLoadFromObject,
 195     DISPID_SRGCmdLoadFromResource,
 196     DISPID_SRGCmdLoadFromMemory,
 197     DISPID_SRGCmdLoadFromProprietaryGrammar,
 198     DISPID_SRGCmdSetRuleState,
 199     DISPID_SRGCmdSetRuleIdState,
 200     DISPID_SRGDictationLoad,
 201     DISPID_SRGDictationUnload,
 202     DISPID_SRGDictationSetState,
 203     DISPID_SRGSetWordSequenceData,
 204     DISPID_SRGSetTextSelection,
 205     DISPID_SRGIsPronounceable
 206 } DISPIDSPRG;
 207
 208 typedef enum SpeechInterference
 209 {
 210     SINone     = SPINTERFERENCE_NONE,
 211     SINoise    = SPINTERFERENCE_NOISE,
 212     SINoSignal = SPINTERFERENCE_NOSIGNAL,
 213     SITooLoud  = SPINTERFERENCE_TOOLOUD,
 214     SITooQuiet = SPINTERFERENCE_TOOQUIET,
 215     SITooFast  = SPINTERFERENCE_TOOFAST,
 216     SITooSlow  = SPINTERFERENCE_TOOSLOW
 217 } SpeechInterference;
 218
 219 typedef enum SpeechVoiceEvents
 220 {
 221     SVEStartInputStream = (1L << 1),
 222     SVEEndInputStream   = (1L << 2),
 223     SVEVoiceChange      = (1L << 3),
 224     SVEBookmark         = (1L << 4),
 225     SVEWordBoundary     = (1L << 5),
 226     SVEPhoneme          = (1L << 6),
 227     SVESentenceBoundary = (1L << 7),
 228     SVEViseme           = (1L << 8),
 229     SVEAudioLevel       = (1L << 9),
 230     SVEPrivate          = (1L << 15),
 231     SVEAllEvents        = 0x083FE
 232 } SpeechVoiceEvents;
 233
 234 typedef enum SpeechVoiceSpeakFlags
 235 {
 236     SVSFDefault          = SPF_DEFAULT,
 237     SVSFlagsAsync        = SPF_ASYNC,
 238     SVSFPurgeBeforeSpeak = SPF_PURGEBEFORESPEAK,
 239     SVSFIsFilename       = SPF_IS_FILENAME,
 240     SVSFIsXML            = SPF_IS_XML,
 241     SVSFIsNotXML         = SPF_IS_NOT_XML,
 242     SVSFPersistXML       = SPF_PERSIST_XML,
 243     SVSFNLPSpeakPunc     = SPF_NLP_SPEAK_PUNC,
 244     SVSFParseSapi        = SPF_PARSE_SAPI,
 245     SVSFParseSsml        = SPF_PARSE_SSML,
 246     SVSFParseAutodetect  = SPF_PARSE_AUTODETECT,
 247     SVSFNLPMask          = SPF_NLP_MASK,
 248     SVSFParseMask        = SPF_PARSE_MASK,
 249     SVSFVoiceMask        = SPF_VOICE_MASK,
 250     SVSFUnusedFlags      = SPF_UNUSED_FLAGS,
 251 } SpeechVoiceSpeakFlags;
 252
 253 typedef enum SpeechGrammarWordType
 254 {
 255     SGDisplay               = SPWT_DISPLAY,
 256     SGLexical               = SPWT_LEXICAL,
 257     SGPronounciation        = SPWT_PRONUNCIATION,
 258     SGLexicalNoSpecialChars = SPWT_LEXICAL_NO_SPECIAL_CHARS
 259 } SpeechGrammarWordType;
 260
 261 typedef enum SpeechRecoEvents
 262 {
 263     SREStreamEnd            = (1L << 0),
 264     SRESoundStart           = (1L << 1),
 265     SRESoundEnd             = (1L << 2),
 266     SREPhraseStart          = (1L << 3),
 267     SRERecognition          = (1L << 4),
 268     SREHypothesis           = (1L << 5),
 269     SREBookmark             = (1L << 6),
 270     SREPropertyNumChange    = (1L << 7),
 271     SREPropertyStringChange = (1L << 8),
 272     SREFalseRecognition     = (1L << 9),
 273     SREInterference         = (1L << 10),
 274     SRERequestUI            = (1L << 11),
 275     SREStateChange          = (1L << 12),
 276     SREAdaptation           = (1L << 13),
 277     SREStreamStart          = (1L << 14),
 278     SRERecoOtherContext     = (1L << 15),
 279     SREAudioLevel           = (1L << 16),
 280     SREPrivate              = (1L << 18),
 281     SREAllEvents            = 0x5FFFF
 282 } SpeechRecoEvents;
 283
 284 typedef enum SpeechRecoContextState
 285 {
 286     SRCS_Disabled = SPCS_DISABLED,
 287     SRCS_Enabled  = SPCS_ENABLED
 288 } SpeechRecoContextState;
 289
 290 typedef enum SpeechRetainedAudioOptions
 291 {
 292     SRAONone        = SPAO_NONE,
 293     SRAORetainAudio = SPAO_RETAIN_AUDIO
 294 } SpeechRetainedAudioOptions;
 295
 296 typedef enum SpeechVoicePriority
 297 {
 298     SVPNormal = SPVPRI_NORMAL,
 299     SVPAlert  = SPVPRI_ALERT,
 300     SVPOver   = SPVPRI_OVER
 301 } SpeechVoicePriority;
 302
 303 [
 304     object,
 305     uuid(ce17c09b-4efa-44d5-a4c9-59d9585ab0cd),
 306     dual,
 307     pointer_default(unique)
 308 ]
 309 interface ISpeechDataKey : IDispatch
 310 {
 311     [id(DISPID_SDKSetBinaryValue)]
 312     HRESULT SetBinaryValue([in] const BSTR name, [in] VARIANT value);
 313
 314     [id(DISPID_SDKGetBinaryValue)]
 315     HRESULT GetBinaryValue([in] const BSTR name, [out,retval] VARIANT *value);
 316
 317     [id(DISPID_SDKSetStringValue)]
 318     HRESULT SetStringValue([in] const BSTR name, [in]const BSTR value);
 319
 320     [id(DISPID_SDKGetStringValue)]
 321     HRESULT GetStringValue([in] const BSTR name, [out,retval] BSTR* value);
 322
 323     [id(DISPID_SDKSetLongValue)]
 324     HRESULT SetLongValue([in] const BSTR name, [in] long value);
 325
 326     [id(DISPID_SDKGetlongValue)]
 327     HRESULT GetLongValue([in] const BSTR name, [out,retval] long *value);
 328
 329     [id(DISPID_SDKOpenKey)]
 330     HRESULT OpenKey( [in] const BSTR name, [out,retval] ISpeechDataKey **key);
 331
 332     [id(DISPID_SDKCreateKey)]
 333     HRESULT CreateKey([in] const BSTR name, [out,retval] ISpeechDataKey **key);
 334
 335     [id(DISPID_SDKDeleteKey)]
 336     HRESULT DeleteKey([in] const BSTR name);
 337
 338     [id(DISPID_SDKDeleteValue)]
 339     HRESULT DeleteValue([in] const BSTR name);
 340
 341     [id(DISPID_SDKEnumKeys)]
 342     HRESULT EnumKeys([in] long index, [out,retval] BSTR *name);
 343
 344     [id(DISPID_SDKEnumValues)]
 345     HRESULT EnumValues([in] long Index, [out,retval] BSTR *value);
 346 }
 347
 348 typedef enum SpeechDataKeyLocation
 349 {
 350     SDKLDefaultLocation = 0,
 351     SDKLCurrentUser     = 1,
 352     SDKLLocalMachine    = 2,
 353     SDKLCurrentConfig   = 5
 354 } SpeechDataKeyLocation;
 355
 356 typedef enum SpeechBookmarkOptions
 357 {
 358     SBONone  = SPBO_NONE,
 359     SBOPause = SPBO_PAUSE
 360 } SpeechBookmarkOptions;
 361
 362 #define CLSCTXALL (CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER | CLSCTX_LOCAL_SERVER | CLSCTX_REMOTE_SERVER)
 363
 364 typedef enum SpeechTokenContext
 365 {
 366     STCInprocServer     = CLSCTX_INPROC_SERVER,
 367     STCInprocHandler    = CLSCTX_INPROC_HANDLER,
 368     STCLocalServer      = CLSCTX_LOCAL_SERVER,
 369     STCRemoteServer     = CLSCTX_REMOTE_SERVER,
 370     STCAll              = CLSCTXALL
 371 } SpeechTokenContext;
 372
 373 typedef [hidden] enum DISPID_SpeechObjectTokenCategory
 374 {
 375     DISPID_SOTCId = 1,
 376     DISPID_SOTCDefault,
 377     DISPID_SOTCSetId,
 378     DISPID_SOTCGetDataKey,
 379     DISPID_SOTCEnumerateTokens,
 380 } DISPID_SpeechObjectTokenCategory;
 381
 382 [
 383     object,
 384     uuid(ca7eac50-2d01-4145-86d4-5ae7d70f4469),
 385     dual,
 386     pointer_default(unique)
 387 ]
 388 interface ISpeechObjectTokenCategory : IDispatch
 389 {
 390     [propget, id(DISPID_SOTCId)]
 391     HRESULT Id([out, retval] BSTR *id);
 392
 393     [propput, id(DISPID_SOTCDefault)]
 394     HRESULT Default([in] const BSTR token);
 395     [propget, id(DISPID_SOTCDefault)]
 396     HRESULT Default([out, retval] BSTR *token);
 397
 398     [id(DISPID_SOTCSetId)]
 399     HRESULT SetId([in] const BSTR id, [in, defaultvalue(0)] VARIANT_BOOL created);
 400
 401     [hidden, id(DISPID_SOTCGetDataKey)]
 402     HRESULT GetDataKey([in, defaultvalue(SDKLDefaultLocation)] SpeechDataKeyLocation location,
 403                        [out, retval] ISpeechDataKey **key);
 404
 405     [id(DISPID_SOTCEnumerateTokens)]
 406     HRESULT EnumerateTokens([in, defaultvalue("")] BSTR required,
 407                              [in, defaultvalue("")] BSTR optional,
 408                              [out, retval] ISpeechObjectTokens **tokens);
 409 }
 410
 411 typedef [hidden] enum DISPID_SpeechObjectToken
 412 {
 413     DISPID_SOTId                        = 1,
 414     DISPID_SOTDataKey,
 415     DISPID_SOTCategory,
 416     DISPID_SOTGetDescription,
 417     DISPID_SOTSetId,
 418     DISPID_SOTGetAttribute,
 419     DISPID_SOTCreateInstance,
 420     DISPID_SOTRemove,
 421     DISPID_SOTGetStorageFileName,
 422     DISPID_SOTRemoveStorageFileName,
 423     DISPID_SOTIsUISupported,
 424     DISPID_SOTDisplayUI,
 425     DISPID_SOTMatchesAttributes
 426 } DISPID_SpeechObjectToken;
 427
 428 [
 429     object,
 430     uuid(c74a3adc-b727-4500-a84a-b526721c8b8c),
 431     dual,
 432     pointer_default(unique)
 433 ]
 434 interface ISpeechObjectToken : IDispatch
 435 {
 436     [propget, id(DISPID_SOTId)]
 437     HRESULT Id([out,retval] BSTR *object);
 438
 439     [propget, id(DISPID_SOTDataKey), hidden]
 440     HRESULT DataKey([out,retval] ISpeechDataKey **key);
 441
 442     [propget, id(DISPID_SOTCategory)]
 443     HRESULT Category([out,retval] ISpeechObjectTokenCategory **category);
 444
 445     [id(DISPID_SOTGetDescription)]
 446     HRESULT GetDescription( [in,defaultvalue(0)] long locale,  [out,retval]BSTR *description);
 447
 448     [hidden, id(DISPID_SOTSetId)]
 449     HRESULT SetId([in] BSTR id, [in, defaultvalue("")] BSTR category, [in, defaultvalue(0)] VARIANT_BOOL create);
 450
 451     [id(DISPID_SOTGetAttribute)]
 452     HRESULT GetAttribute([in] BSTR name, [out, retval] BSTR* value);
 453
 454     [id(DISPID_SOTCreateInstance)]
 455     HRESULT CreateInstance([in, defaultvalue(NULL)] IUnknown *outer,  [in, defaultvalue(STCAll)] SpeechTokenContext spcontext,
 456                                 [out, retval] IUnknown **object);
 457
 458     [hidden, id(DISPID_SOTRemove)]
 459     HRESULT Remove([in] BSTR clsid);
 460
 461     [hidden, id(DISPID_SOTGetStorageFileName)]
 462     HRESULT GetStorageFileName([in] BSTR clsid, [in] BSTR key, [in] BSTR name, [in] SpeechTokenShellFolder folder,
 463                                 [out,retval] BSTR* path);
 464
 465     [hidden, id(DISPID_SOTRemoveStorageFileName)]
 466     HRESULT RemoveStorageFileName([in] BSTR clsid, [in]BSTR key, [in] VARIANT_BOOL remove);
 467
 468     [hidden, id(DISPID_SOTIsUISupported)]
 469     HRESULT IsUISupported( [in]const BSTR type, [in, defaultvalue(NULL)] const VARIANT *data,
 470                                [in, defaultvalue(NULL)] IUnknown *object,
 471                                [out,retval] VARIANT_BOOL *supported);
 472
 473     [hidden, id(DISPID_SOTDisplayUI)]
 474     HRESULT DisplayUI([in] long hwnd, [in] BSTR title, [in]const BSTR type,
 475                            [in, defaultvalue(NULL)] const VARIANT *data,
 476                            [in, defaultvalue(NULL)] IUnknown *object);
 477
 478     [id(DISPID_SOTMatchesAttributes)]
 479     HRESULT MatchesAttributes([in] BSTR attributes, [out,retval] VARIANT_BOOL *matches);
 480 }
 481
 482 typedef [hidden] enum DISPID_SpeechObjectTokens
 483 {
 484     DISPID_SOTsCount    = 1,
 485     DISPID_SOTsItem     = DISPID_VALUE,
 486     DISPID_SOTs_NewEnum = DISPID_NEWENUM
 487 } DISPID_SpeechObjectTokens;
 488
 489 [
 490     object,
 491     uuid(9285b776-2e7b-4bc0-b53e-580eb6fa967f),
 492     dual,
 493     pointer_default(unique)
 494 ]
 495 interface ISpeechObjectTokens : IDispatch
 496 {
 497     [propget, id(DISPID_SOTsCount)]
 498     HRESULT Count([out, retval] long* count);
 499
 500     [id(DISPID_VALUE)]
 501     HRESULT Item([in] long index, [out, retval] ISpeechObjectToken **token);
 502
 503     [propget, restricted, id(DISPID_NEWENUM)]
 504     HRESULT _NewEnum([out, retval] IUnknown **ppenum);
 505 }
 506
 507 typedef [hidden] enum DISPID_SpeechWaveFormatEx
 508 {
 509     DISPID_SWFEFormatTag = 1,
 510     DISPID_SWFEChannels,
 511     DISPID_SWFESamplesPerSec,
 512     DISPID_SWFEAvgBytesPerSec,
 513     DISPID_SWFEBlockAlign,
 514     DISPID_SWFEBitsPerSample,
 515     DISPID_SWFEExtraData
 516 } DISPID_SpeechWaveFormatEx;
 517
 518 [
 519     object,
 520     uuid(7a1ef0d5-1581-4741-88e4-209a49f11a10),
 521     dual,
 522     pointer_default(unique)
 523 ]
 524 interface ISpeechWaveFormatEx : IDispatch
 525 {
 526     [propget, id(DISPID_SWFEFormatTag)]
 527     HRESULT FormatTag([out,retval] short *tag);
 528     [propput, id(DISPID_SWFEFormatTag)]
 529     HRESULT FormatTag([in] short tag);
 530
 531     [propget, id(DISPID_SWFEChannels)]
 532     HRESULT Channels([out,retval] short *channels);
 533     [propput, id(DISPID_SWFEChannels)]
 534     HRESULT Channels([in] short channels);
 535
 536     [propget, id(DISPID_SWFESamplesPerSec)]
 537     HRESULT SamplesPerSec([out,retval] long * samples);
 538     [propput, id(DISPID_SWFESamplesPerSec)]
 539     HRESULT SamplesPerSec([in] long samples);
 540
 541     [propget, id(DISPID_SWFEAvgBytesPerSec)]
 542     HRESULT AvgBytesPerSec([out,retval] long *average);
 543     [propput, id(DISPID_SWFEAvgBytesPerSec)]
 544     HRESULT AvgBytesPerSec([in] long average);
 545
 546     [propget, id(DISPID_SWFEBlockAlign)]
 547     HRESULT BlockAlign([out,retval] short *alignment);
 548     [propput, id(DISPID_SWFEBlockAlign)]
 549     HRESULT BlockAlign([in] short alignment);
 550
 551     [propget, id(DISPID_SWFEBitsPerSample)]
 552     HRESULT BitsPerSample([out,retval] short *bits);
 553     [propput, id(DISPID_SWFEBitsPerSample)]
 554     HRESULT BitsPerSample([in] short bits);
 555
 556     [propget, id(DISPID_SWFEExtraData)]
 557     HRESULT ExtraData([out,retval] VARIANT *data);
 558     [propput, id(DISPID_SWFEExtraData)]
 559     HRESULT ExtraData([in] VARIANT data);
 560 }
 561
 562 typedef enum SpeechAudioFormatType
 563 {
 564     SAFTDefault = -1,
 565     SAFTNoAssignedFormat = 0,
 566     SAFTText,
 567     SAFTNonStandardFormat,
 568     SAFTExtendedAudioFormat,
 569     SAFT8kHz8BitMono,
 570     SAFT8kHz8BitStereo,
 571     SAFT8kHz16BitMono,
 572     SAFT8kHz16BitStereo,
 573     SAFT11kHz8BitMono,
 574     SAFT11kHz8BitStereo,
 575     SAFT11kHz16BitMono,
 576     SAFT11kHz16BitStereo,
 577     SAFT12kHz8BitMono,
 578     SAFT12kHz8BitStereo,
 579     SAFT12kHz16BitMono,
 580     SAFT12kHz16BitStereo,
 581     SAFT16kHz8BitMono,
 582     SAFT16kHz8BitStereo,
 583     SAFT16kHz16BitMono,
 584     SAFT16kHz16BitStereo,
 585     SAFT22kHz8BitMono,
 586     SAFT22kHz8BitStereo,
 587     SAFT22kHz16BitMono,
 588     SAFT22kHz16BitStereo,
 589     SAFT24kHz8BitMono,
 590     SAFT24kHz8BitStereo,
 591     SAFT24kHz16BitMono,
 592     SAFT24kHz16BitStereo,
 593     SAFT32kHz8BitMono,
 594     SAFT32kHz8BitStereo,
 595     SAFT32kHz16BitMono,
 596     SAFT32kHz16BitStereo,
 597     SAFT44kHz8BitMono,
 598     SAFT44kHz8BitStereo,
 599     SAFT44kHz16BitMono,
 600     SAFT44kHz16BitStereo,
 601     SAFT48kHz8BitMono,
 602     SAFT48kHz8BitStereo,
 603     SAFT48kHz16BitMono,
 604     SAFT48kHz16BitStereo,
 605     SAFTTrueSpeech_8kHz1BitMono,
 606     SAFTCCITT_ALaw_8kHzMono,
 607     SAFTCCITT_ALaw_8kHzStereo,
 608     SAFTCCITT_ALaw_11kHzMono,
 609     SAFTCCITT_ALaw_11kHzStereo,
 610     SAFTCCITT_ALaw_22kHzMono,
 611     SAFTCCITT_ALaw_22kHzStereo,
 612     SAFTCCITT_ALaw_44kHzMono,
 613     SAFTCCITT_ALaw_44kHzStereo,
 614     SAFTCCITT_uLaw_8kHzMono,
 615     SAFTCCITT_uLaw_8kHzStereo,
 616     SAFTCCITT_uLaw_11kHzMono,
 617     SAFTCCITT_uLaw_11kHzStereo,
 618     SAFTCCITT_uLaw_22kHzMono,
 619     SAFTCCITT_uLaw_22kHzStereo,
 620     SAFTCCITT_uLaw_44kHzMono,
 621     SAFTCCITT_uLaw_44kHzStereo,
 622     SAFTADPCM_8kHzMono,
 623     SAFTADPCM_8kHzStereo,
 624     SAFTADPCM_11kHzMono,
 625     SAFTADPCM_11kHzStereo,
 626     SAFTADPCM_22kHzMono,
 627     SAFTADPCM_22kHzStereo,
 628     SAFTADPCM_44kHzMono,
 629     SAFTADPCM_44kHzStereo,
 630     SAFTGSM610_8kHzMono,
 631     SAFTGSM610_11kHzMono,
 632     SAFTGSM610_22kHzMono,
 633     SAFTGSM610_44kHzMono,
 634 } SpeechAudioFormatType;
 635
 636 typedef [hidden] enum DISPID_SpeechAudioFormat
 637 {
 638     DISPID_SAFType = 1,
 639     DISPID_SAFGuid,
 640     DISPID_SAFGetWaveFormatEx,
 641     DISPID_SAFSetWaveFormatEx
 642 } DISPID_SpeechAudioFormat;
 643
 644 [
 645     object,
 646     uuid(e6e9c590-3e18-40e3-8299-061f98bde7c7),
 647     dual,
 648     pointer_default(unique)
 649 ]
 650 interface ISpeechAudioFormat : IDispatch
 651 {
 652     [propget, id(DISPID_SAFType)]
 653     HRESULT Type([out,retval] SpeechAudioFormatType *format);
 654     [propput, id(DISPID_SAFType)]
 655     HRESULT Type([in] SpeechAudioFormatType format);
 656
 657     [propget, hidden, id(DISPID_SAFGuid)]
 658     HRESULT Guid([out,retval] BSTR *guid);
 659     [propput, hidden, id(DISPID_SAFGuid)]
 660     HRESULT Guid([in] BSTR guid);
 661
 662     [hidden, id(DISPID_SAFGetWaveFormatEx)]
 663     HRESULT GetWaveFormatEx([out,retval] ISpeechWaveFormatEx **speechwave);
 664
 665     [hidden, id(DISPID_SAFSetWaveFormatEx)]
 666     HRESULT SetWaveFormatEx([in] ISpeechWaveFormatEx *speechwave);
 667 }
 668
 669 typedef enum SpeechStreamSeekPositionType
 670 {
 671     SSSPTRelativeToStart           = STREAM_SEEK_SET,
 672     SSSPTRelativeToCurrentPosition = STREAM_SEEK_CUR,
 673     SSSPTRelativeToEnd             = STREAM_SEEK_END
 674 } SpeechStreamSeekPositionType;
 675
 676 typedef [hidden] enum DISPID_SpeechBaseStream
 677 {
 678     DISPID_SBSFormat = 1,
 679     DISPID_SBSRead,
 680     DISPID_SBSWrite,
 681     DISPID_SBSSeek
 682 } DISPID_SpeechBaseStream;
 683
 684 [
 685     object,
 686     uuid(6450336f-7d49-4ced-8097-49d6dee37294),
 687     dual,
 688     pointer_default(unique)
 689 ]
 690 interface ISpeechBaseStream : IDispatch
 691 {
 692     [propget, id(DISPID_SBSFormat)]
 693     HRESULT Format([out,retval] ISpeechAudioFormat **format);
 694     [propputref, id(DISPID_SBSFormat)]
 695     HRESULT Format([in] ISpeechAudioFormat *format);
 696
 697     [id(DISPID_SBSRead)]
 698     HRESULT Read([out] VARIANT *buffer, [in] long written, [out,retval] long *read);
 699
 700     [id(DISPID_SBSWrite)]
 701     HRESULT Write([in] VARIANT buffer, [out,retval] long *written);
 702
 703     [id(DISPID_SBSSeek)]
 704     HRESULT Seek([in] VARIANT position, [in, defaultvalue(SSSPTRelativeToStart)] SpeechStreamSeekPositionType origin,
 705                     [out,retval] VARIANT *pos);
 706 }
 707
 708 typedef [hidden] enum DISPID_SpeechAudioStatus
 709 {
 710     DISPID_SASFreeBufferSpace = 1,
 711     DISPID_SASNonBlockingIO,
 712     DISPID_SASState,
 713     DISPID_SASCurrentSeekPosition,
 714     DISPID_SASCurrentDevicePosition
 715 } DISPID_SpeechAudioStatus;
 716
 717 [
 718     object,
 719     uuid(c62d9c91-7458-47f6-862d-1ef86fb0b278),
 720     dual,
 721     pointer_default(unique)
 722 ]
 723 interface ISpeechAudioStatus : IDispatch
 724 {
 725     [propget, id(DISPID_SASFreeBufferSpace)]
 726     HRESULT FreeBufferSpace([out,retval] long *space);
 727
 728     [propget, id(DISPID_SASNonBlockingIO)]
 729     HRESULT NonBlockingIO([out,retval] long *nonblocking);
 730
 731     [propget, id(DISPID_SASState)]
 732     HRESULT State([out, retval] SpeechAudioState *state);
 733
 734     [propget, id(DISPID_SASCurrentSeekPosition)]
 735     HRESULT CurrentSeekPosition([out,retval] VARIANT *position);
 736
 737     [propget, id(DISPID_SASCurrentDevicePosition)]
 738     HRESULT CurrentDevicePosition([out,retval] VARIANT *position);
 739 }
 740
 741 typedef [hidden] enum DISPID_SpeechRecognizerStatus
 742 {
 743     DISPID_SRSAudioStatus = 1,
 744     DISPID_SRSCurrentStreamPosition,
 745     DISPID_SRSCurrentStreamNumber,
 746     DISPID_SRSNumberOfActiveRules,
 747     DISPID_SRSClsidEngine,
 748     DISPID_SRSSupportedLanguages
 749 } DISPID_SpeechRecognizerStatus;
 750
 751 [
 752     object,
 753     uuid(bff9e781-53ec-484e-bb8a-0e1b5551e35c),
 754     dual,
 755     pointer_default(unique)
 756 ]
 757 interface ISpeechRecognizerStatus : IDispatch
 758 {
 759     [propget, id(DISPID_SRSAudioStatus)]
 760     HRESULT AudioStatus([out,retval] ISpeechAudioStatus **audio);
 761
 762     [propget, id(DISPID_SRSCurrentStreamPosition)]
 763     HRESULT CurrentStreamPosition([out,retval] VARIANT *pos);
 764
 765     [propget, id(DISPID_SRSCurrentStreamNumber)]
 766     HRESULT CurrentStreamNumber([out,retval] long *number);
 767
 768     [propget, id(DISPID_SRSNumberOfActiveRules)]
 769     HRESULT NumberOfActiveRules([out,retval] long *rules);
 770
 771     [propget, id(DISPID_SRSClsidEngine)]
 772     HRESULT ClsidEngine([out,retval] BSTR *clsid);
 773
 774     [propget, id(DISPID_SRSSupportedLanguages)]
 775     HRESULT SupportedLanguages([out,retval] VARIANT *languages);
 776 }
 777
 778 typedef [hidden] enum DISPID_SpeechVoiceStatus
 779 {
 780     DISPID_SVSCurrentStreamNumber = 1,
 781     DISPID_SVSLastStreamNumberQueued,
 782     DISPID_SVSLastResult,
 783     DISPID_SVSRunningState,
 784     DISPID_SVSInputWordPosition,
 785     DISPID_SVSInputWordLength,
 786     DISPID_SVSInputSentencePosition,
 787     DISPID_SVSInputSentenceLength,
 788     DISPID_SVSLastBookmark,
 789     DISPID_SVSLastBookmarkId,
 790     DISPID_SVSPhonemeId,
 791     DISPID_SVSVisemeId
 792 } DISPID_SpeechVoiceStatus;
 793
 794 [
 795     object,
 796     uuid(8be47b07-57f6-11d2-9eee-00c04f797396),
 797     dual,
 798     pointer_default(unique)
 799 ]
 800 interface ISpeechVoiceStatus : IDispatch
 801 {
 802     [propget, id(DISPID_SVSCurrentStreamNumber)]
 803     HRESULT CurrentStreamNumber([out, retval] long *number);
 804
 805     [propget, id(DISPID_SVSLastStreamNumberQueued)]
 806     HRESULT LastStreamNumberQueued([out, retval] long *number);
 807
 808     [propget, id(DISPID_SVSLastResult)]
 809     HRESULT LastHResult([out, retval]long *result);
 810
 811     [propget, id(DISPID_SVSRunningState)]
 812     HRESULT RunningState([out, retval] SpeechRunState *state);
 813
 814     [propget, id(DISPID_SVSInputWordPosition)]
 815     HRESULT InputWordPosition([out, retval] long *position);
 816
 817     [propget, id(DISPID_SVSInputWordLength)]
 818     HRESULT InputWordLength([out, retval] long *length);
 819
 820     [propget, id(DISPID_SVSInputSentencePosition)]
 821     HRESULT InputSentencePosition([out, retval] long *position);
 822
 823     [propget, id(DISPID_SVSInputSentenceLength)]
 824     HRESULT InputSentenceLength([out, retval] long *length);
 825
 826     [propget, id(DISPID_SVSLastBookmark)]
 827     HRESULT LastBookmark([out, retval] BSTR *bookmark);
 828
 829     [propget, id(DISPID_SVSLastBookmarkId), hidden]
 830     HRESULT LastBookmarkId([out, retval] long *bookmark);
 831
 832     [propget, id(DISPID_SVSPhonemeId)]
 833     HRESULT PhonemeId([out, retval] short *phone);
 834
 835     [propget, id(DISPID_SVSVisemeId)]
 836     HRESULT VisemeId([out, retval] short *id);
 837 }
 838
 839 typedef [hidden] enum DISPID_SpeechVoice
 840 {
 841     DISPID_SVStatus = 1,
 842     DISPID_SVVoice,
 843     DISPID_SVAudioOutput,
 844     DISPID_SVAudioOutputStream,
 845     DISPID_SVRate,
 846     DISPID_SVVolume,
 847     DISPID_SVAllowAudioOuputFormatChangesOnNextSet,
 848     DISPID_SVEventInterests,
 849     DISPID_SVPriority,
 850     DISPID_SVAlertBoundary,
 851     DISPID_SVSyncronousSpeakTimeout,
 852     DISPID_SVSpeak,
 853     DISPID_SVSpeakStream,
 854     DISPID_SVPause,
 855     DISPID_SVResume,
 856     DISPID_SVSkip,
 857     DISPID_SVGetVoices,
 858     DISPID_SVGetAudioOutputs,
 859     DISPID_SVWaitUntilDone,
 860     DISPID_SVSpeakCompleteEvent,
 861     DISPID_SVIsUISupported,
 862     DISPID_SVDisplayUI
 863 } DISPID_SpeechVoice;
 864
 865 [
 866     object,
 867     uuid(269316d8-57bd-11d2-9eee-00c04f797396),
 868     dual,
 869     pointer_default(unique)
 870 ]
 871 interface ISpeechVoice : IDispatch
 872 {
 873     [propget, id(DISPID_SVStatus)]
 874     HRESULT Status([out, retval] ISpeechVoiceStatus **Status);
 875
 876     [propget, id(DISPID_SVVoice)]
 877     HRESULT Voice([out, retval] ISpeechObjectToken **voice);
 878
 879     [propputref, id(DISPID_SVVoice)]
 880     HRESULT Voice([in] ISpeechObjectToken *voice);
 881
 882     [propget, id(DISPID_SVAudioOutput)]
 883     HRESULT AudioOutput([out, retval] ISpeechObjectToken **output);
 884
 885     [propputref, id(DISPID_SVAudioOutput)]
 886     HRESULT AudioOutput([in] ISpeechObjectToken *output);
 887
 888     [propget, id(DISPID_SVAudioOutputStream)]
 889     HRESULT AudioOutputStream([out, retval] ISpeechBaseStream **output);
 890
 891     [propputref, id(DISPID_SVAudioOutputStream)]
 892     HRESULT AudioOutputStream([in] ISpeechBaseStream *output);
 893
 894     [propget, id(DISPID_SVRate)]
 895     HRESULT Rate([out, retval] long *rate);
 896
 897     [propput, id(DISPID_SVRate)]
 898     HRESULT Rate([in] long rate);
 899
 900     [propget, id(DISPID_SVVolume)]
 901     HRESULT Volume([out, retval] long *volume);
 902
 903     [propput, id(DISPID_SVVolume)]
 904     HRESULT Volume([in] long volume);
 905
 906     [propput, hidden, id(DISPID_SVAllowAudioOuputFormatChangesOnNextSet)]
 907     HRESULT AllowAudioOutputFormatChangesOnNextSet([in] VARIANT_BOOL allow);
 908
 909     [propget, hidden, id(DISPID_SVAllowAudioOuputFormatChangesOnNextSet)]
 910     HRESULT AllowAudioOutputFormatChangesOnNextSet([out,retval] VARIANT_BOOL *allow);
 911
 912     [propget, id(DISPID_SVEventInterests)]
 913     HRESULT EventInterests([out,retval] SpeechVoiceEvents *flags);
 914
 915     [propput, id(DISPID_SVEventInterests)]
 916     HRESULT EventInterests([in] SpeechVoiceEvents flags);
 917
 918     [propput, id(DISPID_SVPriority)]
 919     HRESULT Priority([in] SpeechVoicePriority vpriority);
 920
 921     [propget, id(DISPID_SVPriority)]
 922     HRESULT Priority([out,retval] SpeechVoicePriority *vpriority);
 923
 924     [propput, id(DISPID_SVAlertBoundary)]
 925     HRESULT AlertBoundary([in] SpeechVoiceEvents boundary);
 926
 927     [propget, id(DISPID_SVAlertBoundary)]
 928     HRESULT AlertBoundary([out,retval] SpeechVoiceEvents *boundary);
 929
 930     [propput, id(DISPID_SVSyncronousSpeakTimeout)]
 931     HRESULT SynchronousSpeakTimeout([in] long timeout);
 932
 933     [propget, id(DISPID_SVSyncronousSpeakTimeout)]
 934     HRESULT SynchronousSpeakTimeout([out,retval] long *timeout);
 935
 936     [id(DISPID_SVSpeak)]
 937     HRESULT Speak([in] BSTR text, [in, defaultvalue(SPF_DEFAULT)] SpeechVoiceSpeakFlags flags,
 938                        [out, retval] long *number);
 939
 940     [id(DISPID_SVSpeakStream)]
 941     HRESULT SpeakStream([in] ISpeechBaseStream *stream, [in, defaultvalue(SPF_DEFAULT)] SpeechVoiceSpeakFlags flags,
 942                              [out, retval] long *number);
 943
 944     [id(DISPID_SVPause)]
 945     HRESULT Pause(void);
 946
 947     [id(DISPID_SVResume)]
 948     HRESULT Resume(void);
 949
 950     [id(DISPID_SVSkip)]
 951     HRESULT Skip([in] const BSTR type, [in] long items, [out,retval ]long *skipped);
 952
 953     [id(DISPID_SVGetVoices)]
 954     HRESULT GetVoices([in, defaultvalue("")] BSTR required, [in, defaultvalue("")] BSTR optional,
 955                           [out,retval] ISpeechObjectTokens **tokens);
 956
 957     [id(DISPID_SVGetAudioOutputs)]
 958     HRESULT GetAudioOutputs([in, defaultvalue("")] BSTR required, [in, defaultvalue("")] BSTR optional,
 959                                 [out,retval] ISpeechObjectTokens **tokens);
 960
 961     [id(DISPID_SVWaitUntilDone)]
 962     HRESULT WaitUntilDone([in] long msTimeout, [out,retval] VARIANT_BOOL *done);
 963
 964     [hidden, id(DISPID_SVSpeakCompleteEvent)]
 965     HRESULT SpeakCompleteEvent([out,retval] long *handle);
 966
 967     [id(DISPID_SVIsUISupported)]
 968         HRESULT IsUISupported( [in] const BSTR typeui, [in, defaultvalue(NULL)] const VARIANT *data,
 969                                [out,retval] VARIANT_BOOL *supported);
 970
 971     [id(DISPID_SVDisplayUI)]
 972     HRESULT DisplayUI([in] long hwnd, [in] BSTR title, [in] const BSTR typeui, [in, defaultvalue(NULL)] const VARIANT *data);
 973 }
 974
 975 typedef [hidden] enum DISPID_SpeechRecoResultTimes
 976 {
 977     DISPID_SRRTStreamTime = 1,
 978     DISPID_SRRTLength,
 979     DISPID_SRRTTickCount,
 980     DISPID_SRRTOffsetFromStart
 981 } DISPID_SpeechRecoResultTimes;
 982
 983 [
 984     object,
 985     uuid(62b3b8fb-f6e7-41be-bdcb-056b1c29efc0),
 986     dual,
 987     pointer_default(unique)
 988 ]
 989 interface ISpeechRecoResultTimes : IDispatch
 990 {
 991     [propget, id(DISPID_SRRTStreamTime)]
 992     HRESULT StreamTime([out,retval] VARIANT *streamtime);
 993
 994     [propget, id(DISPID_SRRTLength)]
 995     HRESULT Length([out,retval] VARIANT *length);
 996
 997     [propget, id(DISPID_SRRTTickCount)]
 998     HRESULT TickCount([out,retval] long *count);
 999
1000     [propget, id(DISPID_SRRTOffsetFromStart)]
1001     HRESULT OffsetFromStart([out,retval] VARIANT *offset);
1002 }
1003
1004 typedef [hidden] enum DISPID_SpeechPhraseRules
1005 {
1006     DISPID_SPRulesCount    = 1,
1007     DISPID_SPRulesItem     = DISPID_VALUE,
1008     DISPID_SPRules_NewEnum = DISPID_NEWENUM
1009 } DISPID_SpeechPhraseRules;
1010
1011 [
1012     object,
1013     uuid(9047d593-01dd-4b72-81a3-e4a0ca69f407),
1014     dual,
1015     pointer_default(unique)
1016 ]
1017 interface ISpeechPhraseRules : IDispatch
1018 {
1019     [propget, id(DISPID_SPRulesCount)]
1020     HRESULT Count([out, retval] long *count);
1021
1022     [id(DISPID_SPRulesItem)]
1023     HRESULT Item([in] long index, [out, retval] ISpeechPhraseRule **rule);
1024
1025     [propget, restricted, id(DISPID_SPRules_NewEnum)]
1026     HRESULT _NewEnum([out, retval] IUnknown **obj);
1027 }
1028
1029 typedef [hidden] enum DISPID_SpeechPhraseRule
1030 {
1031     DISPID_SPRuleName = 1,
1032     DISPID_SPRuleId,
1033     DISPID_SPRuleFirstElement,
1034     DISPID_SPRuleNumberOfElements,
1035     DISPID_SPRuleParent,
1036     DISPID_SPRuleChildren,
1037     DISPID_SPRuleConfidence,
1038     DISPID_SPRuleEngineConfidence
1039 } DISPID_SpeechPhraseRule;
1040
1041 [
1042     object,
1043     uuid(a7bfe112-a4a0-48d9-b602-c313843f6964),
1044     dual,
1045     pointer_default(unique)
1046 ]
1047 interface ISpeechPhraseRule : IDispatch
1048 {
1049     [propget, id(DISPID_SPRuleName)]
1050     HRESULT Name([out, retval]BSTR *name);
1051
1052     [propget, id(DISPID_SPRuleId)]
1053     HRESULT Id( [out, retval] long *id);
1054
1055     [propget, id(DISPID_SPRuleFirstElement)]
1056     HRESULT FirstElement([out, retval] long *element);
1057
1058     [propget, id(DISPID_SPRuleNumberOfElements)]
1059     HRESULT NumberOfElements([out, retval] long *count);
1060
1061     [propget, id(DISPID_SPRuleParent)]
1062     HRESULT Parent([out, retval] ISpeechPhraseRule **parent);
1063
1064     [propget, id(DISPID_SPRuleChildren)]
1065     HRESULT Children([out, retval] ISpeechPhraseRules **children);
1066
1067     [propget, id(DISPID_SPRuleConfidence)]
1068     HRESULT Confidence([out, retval] SpeechEngineConfidence *confidence);
1069
1070     [propget, id(DISPID_SPRuleEngineConfidence)]
1071     HRESULT EngineConfidence([out, retval] float *confidence);
1072 }
1073
1074 typedef [hidden] enum DISPID_SpeechPhraseProperty
1075 {
1076     DISPID_SPPName = 1,
1077     DISPID_SPPId,
1078     DISPID_SPPValue,
1079     DISPID_SPPFirstElement,
1080     DISPID_SPPNumberOfElements,
1081     DISPID_SPPEngineConfidence,
1082     DISPID_SPPConfidence,
1083     DISPID_SPPParent,
1084     DISPID_SPPChildren
1085 } DISPID_SpeechPhraseProperty;
1086
1087 [
1088     object,
1089     uuid(CE563D48-961E-4732-A2E1-378A42B430BE),
1090     dual,
1091     pointer_default(unique)
1092 ]
1093 interface ISpeechPhraseProperty : IDispatch
1094 {
1095     [propget, id(DISPID_SPPName)]
1096     HRESULT Name([out, retval] BSTR *name);
1097
1098     [propget, id(DISPID_SPPId)]
1099     HRESULT Id([out, retval] long *id);
1100
1101     [propget, id(DISPID_SPPValue)]
1102     HRESULT Value([out, retval] VARIANT *value);
1103
1104     [propget, id(DISPID_SPPFirstElement)]
1105     HRESULT FirstElement( [out, retval] long *element);
1106
1107     [propget, id(DISPID_SPPNumberOfElements)]
1108     HRESULT NumberOfElements([out, retval] long *elements);
1109
1110     [propget, id(DISPID_SPPEngineConfidence)]
1111     HRESULT EngineConfidence([out, retval] float *confidence);
1112
1113     [propget, id(DISPID_SPPConfidence)]
1114     HRESULT Confidence([out, retval] SpeechEngineConfidence *Confidence);
1115
1116     [propget, id(DISPID_SPPParent)]
1117     HRESULT Parent([out, retval] ISpeechPhraseProperty **parent);
1118
1119     [propget, id(DISPID_SPPChildren)]
1120     HRESULT Children( [out, retval] ISpeechPhraseProperties **children);
1121 }
1122
1123 typedef [hidden] enum DISPID_SpeechPhraseProperties
1124 {
1125     DISPID_SPPsCount = 1,
1126     DISPID_SPPsItem = DISPID_VALUE,
1127     DISPID_SPPs_NewEnum = DISPID_NEWENUM
1128 } DISPID_SpeechPhraseProperties;
1129
1130 [
1131     object,
1132     uuid(08166b47-102e-4b23-a599-bdb98dbfd1f4),
1133     dual,
1134     pointer_default(unique)
1135 ]
1136 interface ISpeechPhraseProperties : IDispatch
1137 {
1138     [propget, id(DISPID_SPPsCount)]
1139     HRESULT Count([out, retval] long *count);
1140
1141     [id(DISPID_SPPsItem)]
1142     HRESULT Item([in] long index, [out, retval] ISpeechPhraseProperty **obj);
1143
1144     [propget, restricted, id(DISPID_SPPs_NewEnum)]
1145     HRESULT _NewEnum([out, retval] IUnknown **obj);
1146 }
1147
1148 typedef [hidden] enum DISPID_SpeechPhraseElement
1149 {
1150     DISPID_SPEAudioTimeOffset = 1,
1151     DISPID_SPEAudioSizeTime,
1152     DISPID_SPEAudioStreamOffset,
1153     DISPID_SPEAudioSizeBytes,
1154     DISPID_SPERetainedStreamOffset,
1155     DISPID_SPERetainedSizeBytes,
1156     DISPID_SPEDisplayText,
1157     DISPID_SPELexicalForm,
1158     DISPID_SPEPronunciation,
1159     DISPID_SPEDisplayAttributes,
1160     DISPID_SPERequiredConfidence,
1161     DISPID_SPEActualConfidence,
1162     DISPID_SPEEngineConfidence
1163 } DISPID_SpeechPhraseElement;
1164
1165 [
1166     object,
1167     uuid(e6176f96-e373-4801-b223-3b62c068c0b4),
1168     dual,
1169     pointer_default(unique)
1170 ]
1171 interface ISpeechPhraseElement : IDispatch
1172 {
1173     [propget, id(DISPID_SPEAudioTimeOffset)]
1174     HRESULT AudioTimeOffset( [out, retval] long *offset);
1175
1176     [propget, id(DISPID_SPEAudioSizeTime)]
1177     HRESULT AudioSizeTime([out, retval] long *audiotime);
1178
1179     [propget, id(DISPID_SPEAudioStreamOffset)]
1180     HRESULT AudioStreamOffset([out, retval] long *offset);
1181
1182     [propget, id(DISPID_SPEAudioSizeBytes)]
1183     HRESULT AudioSizeBytes([out, retval]long *bytes);
1184
1185     [propget, id(DISPID_SPERetainedStreamOffset)]
1186     HRESULT RetainedStreamOffset([out, retval] long *offset);
1187
1188     [propget, id(DISPID_SPERetainedSizeBytes)]
1189     HRESULT RetainedSizeBytes([out, retval] long *retained);
1190
1191     [propget, id(DISPID_SPEDisplayText)]
1192     HRESULT DisplayText([out, retval] BSTR *display);
1193
1194     [propget, id(DISPID_SPELexicalForm)]
1195     HRESULT LexicalForm( [out, retval] BSTR *lexical);
1196
1197     [propget, id(DISPID_SPEPronunciation)]
1198     HRESULT Pronunciation([out, retval] VARIANT *pronunciation);
1199
1200     [propget, id(DISPID_SPEDisplayAttributes)]
1201     HRESULT DisplayAttributes([out, retval] SpeechDisplayAttributes *attributes);
1202
1203     [propget, id(DISPID_SPERequiredConfidence)]
1204     HRESULT RequiredConfidence([out, retval] SpeechEngineConfidence *confidence);
1205
1206     [propget, id(DISPID_SPEActualConfidence)]
1207     HRESULT ActualConfidence([out, retval] SpeechEngineConfidence *confidence);
1208
1209     [propget, id(DISPID_SPEEngineConfidence)]
1210     HRESULT EngineConfidence([out, retval] float *confidence);
1211 }
1212
1213 typedef [hidden] enum DISPID_SpeechPhraseElements
1214 {
1215     DISPID_SPEsCount    = 1,
1216     DISPID_SPEsItem     = DISPID_VALUE,
1217     DISPID_SPEs_NewEnum = DISPID_NEWENUM
1218 } DISPID_SpeechPhraseElements;
1219
1220 [
1221     object,
1222     uuid(0626b328-3478-467d-a0b3-d0853b93dda3),
1223     dual,
1224     pointer_default(unique)
1225 ]
1226 interface ISpeechPhraseElements : IDispatch
1227 {
1228     [propget, id(DISPID_SPEsCount)]
1229     HRESULT Count([out, retval] long *count);
1230
1231     [id(DISPID_SPEsItem)]
1232     HRESULT Item([in] long Index, [out, retval] ISpeechPhraseElement **element);
1233
1234     [propget, restricted, id(DISPID_SPEs_NewEnum)]
1235     HRESULT _NewEnum([out, retval] IUnknown **obj);
1236 }
1237
1238 typedef [hidden] enum DISPID_SpeechPhraseReplacement
1239 {
1240     DISPID_SPRDisplayAttributes = 1,
1241     DISPID_SPRText,
1242     DISPID_SPRFirstElement,
1243     DISPID_SPRNumberOfElements
1244 } DISPID_SpeechPhraseReplacement;
1245
1246 [
1247     object,
1248     uuid(2890a410-53a7-4fb5-94ec-06d4998e3d02),
1249     dual,
1250     pointer_default(unique)
1251 ]
1252 interface ISpeechPhraseReplacement : IDispatch
1253 {
1254     [propget, id(DISPID_SPRDisplayAttributes)]
1255     HRESULT DisplayAttributes([out,retval] SpeechDisplayAttributes *attributes);
1256
1257     [propget, id(DISPID_SPRText)]
1258     HRESULT Text([out, retval] BSTR *text);
1259
1260     [propget, id(DISPID_SPRFirstElement)]
1261     HRESULT FirstElement([out, retval] long *element);
1262
1263     [propget, id(DISPID_SPRNumberOfElements)]
1264     HRESULT NumberOfElements([out, retval] long *elements);
1265 }
1266
1267 typedef [hidden] enum DISPID_SpeechPhraseReplacements
1268 {
1269     DISPID_SPRsCount = 1,
1270     DISPID_SPRsItem = DISPID_VALUE,
1271     DISPID_SPRs_NewEnum = DISPID_NEWENUM
1272 } DISPID_SpeechPhraseReplacements;
1273
1274 [
1275     object,
1276     uuid(38bc662f-2257-4525-959e-2069d2596c05),
1277     dual,
1278     pointer_default(unique)
1279 ]
1280 interface ISpeechPhraseReplacements : IDispatch
1281 {
1282     [propget, id(DISPID_SPRsCount)]
1283     HRESULT Count([out, retval] long *count);
1284
1285     [id(DISPID_SPRsItem)]
1286     HRESULT Item([in] long index, [out, retval] ISpeechPhraseReplacement **reps);
1287
1288     [propget, restricted, id(DISPID_SPRs_NewEnum)]
1289     HRESULT _NewEnum([out, retval] IUnknown **obj);
1290 }
1291
1292 typedef [hidden] enum DISPID_SpeechPhraseInfo
1293 {
1294     DISPID_SPILanguageId = 1,
1295     DISPID_SPIGrammarId,
1296     DISPID_SPIStartTime,
1297     DISPID_SPIAudioStreamPosition,
1298     DISPID_SPIAudioSizeBytes,
1299     DISPID_SPIRetainedSizeBytes,
1300     DISPID_SPIAudioSizeTime,
1301     DISPID_SPIRule,
1302     DISPID_SPIProperties,
1303     DISPID_SPIElements,
1304     DISPID_SPIReplacements,
1305     DISPID_SPIEngineId,
1306     DISPID_SPIEnginePrivateData,
1307     DISPID_SPISaveToMemory,
1308     DISPID_SPIGetText,
1309     DISPID_SPIGetDisplayAttributes
1310 } DISPID_SpeechPhraseInfo;
1311
1312 [
1313     object,
1314     uuid(961559cf-4e67-4662-8bf0-d93f1fcd61b3),
1315     dual,
1316     pointer_default(unique)
1317 ]
1318 interface ISpeechPhraseInfo : IDispatch
1319 {
1320     [propget, id(DISPID_SPILanguageId)]
1321     HRESULT LanguageId( [out, retval] long *language);
1322
1323     [propget, id(DISPID_SPIGrammarId)]
1324     HRESULT GrammarId([out, retval] VARIANT *grammar);
1325
1326     [propget, id(DISPID_SPIStartTime)]
1327     HRESULT StartTime([out, retval]VARIANT *start);
1328
1329     [propget, id(DISPID_SPIAudioStreamPosition)]
1330     HRESULT AudioStreamPosition([out, retval] VARIANT *position);
1331
1332     [propget, id(DISPID_SPIAudioSizeBytes)]
1333     HRESULT AudioSizeBytes([out, retval] long *bytes);
1334
1335     [propget, id(DISPID_SPIRetainedSizeBytes)]
1336     HRESULT RetainedSizeBytes([out, retval] long *bytes);
1337
1338     [propget, id(DISPID_SPIAudioSizeTime)]
1339     HRESULT AudioSizeTime([out, retval] long *audiotime);
1340
1341     [propget, id(DISPID_SPIRule)]
1342     HRESULT Rule([out, retval] ISpeechPhraseRule **rule);
1343
1344     [propget, id(DISPID_SPIProperties)]
1345     HRESULT Properties([out, retval] ISpeechPhraseProperties **props);
1346
1347     [propget, id(DISPID_SPIElements)]
1348     HRESULT Elements([out, retval] ISpeechPhraseElements **elements);
1349
1350     [propget, id(DISPID_SPIReplacements)]
1351     HRESULT Replacements([out, retval] ISpeechPhraseReplacements **replacements);
1352
1353     [propget, id(DISPID_SPIEngineId)]
1354     HRESULT EngineId([out, retval] BSTR *engine);
1355
1356     [propget, id(DISPID_SPIEnginePrivateData)]
1357     HRESULT EnginePrivateData([out, retval] VARIANT *data);
1358
1359     [id(DISPID_SPISaveToMemory)]
1360     HRESULT SaveToMemory([out,retval] VARIANT *block);
1361
1362     [id(DISPID_SPIGetText)]
1363     HRESULT GetText([in, defaultvalue(0)] long start,
1364                 [in, defaultvalue(SPPR_ALL_ELEMENTS)] long elements,
1365                 [in, defaultvalue(-1)] VARIANT_BOOL replacements, [out,retval] BSTR *text);
1366
1367     [id(DISPID_SPIGetDisplayAttributes)]
1368     HRESULT GetDisplayAttributes([in, defaultvalue(0)] long start,
1369                 [in, defaultvalue(SPPR_ALL_ELEMENTS)] long elements,
1370                 [in, defaultvalue(-1)] VARIANT_BOOL replacements,
1371                 [out,retval] SpeechDisplayAttributes *attributes);
1372 }
1373
1374 typedef [hidden] enum DISPID_SpeechPhraseAlternate
1375 {
1376     DISPID_SPARecoResult = 1,
1377     DISPID_SPAStartElementInResult,
1378     DISPID_SPANumberOfElementsInResult,
1379     DISPID_SPAPhraseInfo,
1380     DISPID_SPACommit
1381 } DISPID_SpeechPhraseAlternate;
1382
1383 [
1384     object,
1385     uuid(27864a2a-2b9f-4cb8-92d3-0d2722fd1e73),
1386     dual,
1387     pointer_default(unique)
1388 ]
1389 interface ISpeechPhraseAlternate : IDispatch
1390 {
1391     [propget, id(DISPID_SPARecoResult)]
1392     HRESULT RecoResult( [out,retval] ISpeechRecoResult **result);
1393
1394     [propget, id(DISPID_SPAStartElementInResult)]
1395     HRESULT StartElementInResult([out,retval] long *element);
1396
1397     [propget, id(DISPID_SPANumberOfElementsInResult)]
1398     HRESULT NumberOfElementsInResult([out,retval] long *elements);
1399
1400     [propget, id(DISPID_SPAPhraseInfo)]
1401     HRESULT PhraseInfo( [out,retval] ISpeechPhraseInfo **PhraseInfo);
1402
1403     [id(DISPID_SPACommit)]
1404     HRESULT Commit(void);
1405 }
1406
1407 typedef [hidden] enum DISPID_SpeechPhraseAlternates
1408 {
1409     DISPID_SPAsCount = 1,
1410     DISPID_SPAsItem = DISPID_VALUE,
1411     DISPID_SPAs_NewEnum = DISPID_NEWENUM
1412 } DISPID_SpeechPhraseAlternates;
1413
1414 [
1415     object,
1416     uuid(b238b6d5-f276-4c3d-a6c1-2974801c3cc2),
1417     dual,
1418     pointer_default(unique)
1419 ]
1420 interface ISpeechPhraseAlternates : IDispatch
1421 {
1422     [propget, id(DISPID_SPAsCount)]
1423     HRESULT Count([out, retval] long *count);
1424
1425     [id(DISPID_SPAsItem)]
1426     HRESULT Item([in] long index, [out, retval] ISpeechPhraseAlternate **alternate);
1427
1428     [propget, restricted, id(DISPID_SPAs_NewEnum)]
1429     HRESULT _NewEnum([out, retval] IUnknown **obj);
1430 }
1431
1432 typedef [hidden] enum DISPID_SpeechMemoryStream
1433 {
1434     DISPID_SMSSetData = 100,
1435     DISPID_SMSGetData
1436 } DISPID_SpeechMemoryStream;
1437
1438 [
1439     object,
1440     uuid(eeb14b68-808b-4abe-a5ea-b51da7588008),
1441     dual,
1442     pointer_default(unique)
1443 ]
1444 interface ISpeechMemoryStream : ISpeechBaseStream
1445 {
1446     [id(DISPID_SMSSetData)]
1447     HRESULT SetData([in] VARIANT data);
1448
1449     [id(DISPID_SMSGetData)]
1450     HRESULT GetData([out, retval] VARIANT *data);
1451 }
1452
1453 typedef [hidden] enum DISPID_SpeechRecoResult
1454 {
1455     DISPID_SRRRecoContext = 1,
1456     DISPID_SRRTimes,
1457     DISPID_SRRAudioFormat,
1458     DISPID_SRRPhraseInfo,
1459     DISPID_SRRAlternates,
1460     DISPID_SRRAudio,
1461     DISPID_SRRSpeakAudio,
1462     DISPID_SRRSaveToMemory,
1463     DISPID_SRRDiscardResultInfo
1464 } DISPID_SpeechRecoResult;
1465
1466 [
1467     object,
1468     uuid(ed2879cf-ced9-4ee6-a534-de0191d5468d),
1469     dual,
1470     pointer_default(unique)
1471 ]
1472 interface ISpeechRecoResult : IDispatch
1473 {
1474     [propget, id(DISPID_SRRRecoContext)]
1475     HRESULT RecoContext( [out,retval] ISpeechRecoContext** RecoContext );
1476
1477     [propget, id(DISPID_SRRTimes)]
1478     HRESULT Times([out,retval] ISpeechRecoResultTimes **times);
1479
1480     [propputref, id(DISPID_SRRAudioFormat)]
1481     HRESULT AudioFormat([in]ISpeechAudioFormat *format);
1482     [propget, id(DISPID_SRRAudioFormat)]
1483     HRESULT AudioFormat([out,retval] ISpeechAudioFormat **format);
1484
1485     [propget, id(DISPID_SRRPhraseInfo)]
1486     HRESULT PhraseInfo([out,retval] ISpeechPhraseInfo **phrase);
1487
1488     [id(DISPID_SRRAlternates)]
1489     HRESULT Alternates( [in] long count, [in, defaultvalue(0)] long start,
1490                 [in, defaultvalue(SPPR_ALL_ELEMENTS)] long elements,
1491                 [out,retval] ISpeechPhraseAlternates **alternates);
1492
1493     [id(DISPID_SRRAudio)]
1494     HRESULT Audio([in, defaultvalue(0)] long start,
1495                 [in, defaultvalue(SPPR_ALL_ELEMENTS)] long elements,
1496                 [out,retval] ISpeechMemoryStream **stream);
1497
1498     [id(DISPID_SRRSpeakAudio)]
1499     HRESULT SpeakAudio([in, defaultvalue(0)] long start,
1500                 [in, defaultvalue(SPPR_ALL_ELEMENTS)] long elements,
1501                 [in, defaultvalue(SPF_DEFAULT)] SpeechVoiceSpeakFlags flags,
1502                 [out,retval] long *stream);
1503
1504     [id(DISPID_SRRSaveToMemory)]
1505     HRESULT SaveToMemory([out,retval] VARIANT *block);
1506
1507     [id(DISPID_SRRDiscardResultInfo)]
1508     HRESULT DiscardResultInfo([in] SpeechDiscardType types);
1509 }
1510
1511 typedef [hidden] enum DISPID_SpeechGrammarRule
1512 {
1513     DISPID_SGRAttributes = 1,
1514     DISPID_SGRInitialState,
1515     DISPID_SGRName,
1516     DISPID_SGRId,
1517     DISPID_SGRClear,
1518     DISPID_SGRAddResource,
1519     DISPID_SGRAddState
1520 } DISPID_SpeechGrammarRule;
1521
1522 typedef [hidden] enum DISPID_SpeechGrammarRuleStateTransitions
1523 {
1524     DISPID_SGRSTsCount = 1,
1525     DISPID_SGRSTsItem = DISPID_VALUE,
1526     DISPID_SGRSTs_NewEnum = DISPID_NEWENUM
1527 } DISPID_SpeechGrammarRuleStateTransitions;
1528
1529 typedef enum SpeechGrammarRuleStateTransitionType
1530 {
1531     SGRSTTEpsilon = 0,
1532     SGRSTTWord,
1533     SGRSTTRule,
1534     SGRSTTDictation,
1535     SGRSTTWildcard,
1536     SGRSTTTextBuffer
1537 } SpeechGrammarRuleStateTransitionType;
1538
1539 typedef [hidden] enum DISPID_SpeechGrammarRuleStateTransition
1540 {
1541     DISPID_SGRSTType = 1,
1542     DISPID_SGRSTText,
1543     DISPID_SGRSTRule,
1544     DISPID_SGRSTWeight,
1545     DISPID_SGRSTPropertyName,
1546     DISPID_SGRSTPropertyId,
1547     DISPID_SGRSTPropertyValue,
1548     DISPID_SGRSTNextState
1549 } DISPID_SpeechGrammarRuleStateTransition;
1550
1551 [
1552     object,
1553     uuid(cafd1db1-41d1-4a06-9863-e2e81da17a9a),
1554     dual,
1555     pointer_default(unique)
1556 ]
1557 interface ISpeechGrammarRuleStateTransition : IDispatch
1558 {
1559     [propget, id(DISPID_SGRSTType)]
1560     HRESULT Type([out, retval] SpeechGrammarRuleStateTransitionType *type);
1561
1562     [propget, id(DISPID_SGRSTText)]
1563     HRESULT Text([out, retval] BSTR *text);
1564
1565     [propget, id(DISPID_SGRSTRule)]
1566     HRESULT Rule([out, retval] ISpeechGrammarRule **rule);
1567
1568     [propget, id(DISPID_SGRSTWeight)]
1569     HRESULT Weight([out, retval] VARIANT *weight);
1570
1571     [propget, id(DISPID_SGRSTPropertyName)]
1572     HRESULT PropertyName([out, retval] BSTR *name);
1573
1574     [propget, id(DISPID_SGRSTPropertyId)]
1575     HRESULT PropertyId([out, retval] long *id);
1576
1577     [propget, id(DISPID_SGRSTPropertyValue)]
1578     HRESULT PropertyValue([out, retval] VARIANT *value);
1579
1580     [propget, id(DISPID_SGRSTNextState)]
1581     HRESULT NextState([out, retval] ISpeechGrammarRuleState **state);
1582 }
1583
1584 [
1585     object,
1586     uuid(EABCE657-75BC-44a2-AA7F-C56476742963),
1587     dual,
1588     pointer_default(unique)
1589 ]
1590 interface ISpeechGrammarRuleStateTransitions : IDispatch
1591 {
1592     [propget, id(DISPID_SGRSTsCount)]
1593     HRESULT Count([out, retval] long *count);
1594
1595     [id(DISPID_SGRSTsItem)]
1596     HRESULT Item([in] long index, [out, retval] ISpeechGrammarRuleStateTransition **transition);
1597
1598     [propget, restricted, id(DISPID_SGRSTs_NewEnum)]
1599     HRESULT _NewEnum([out, retval] IUnknown **enum_var);
1600 }
1601
1602 typedef [hidden] enum DISPID_SpeechGrammarRuleState
1603 {
1604     DISPID_SGRSRule = 1,
1605     DISPID_SGRSTransitions,
1606     DISPID_SGRSAddWordTransition,
1607     DISPID_SGRSAddRuleTransition,
1608     DISPID_SGRSAddSpecialTransition
1609 } DISPID_SpeechGrammarRuleState;
1610
1611 [
1612     object,
1613     uuid(d4286f2c-ee67-45ae-b928-28d695362eda),
1614     dual,
1615     pointer_default(unique)
1616 ]
1617 interface ISpeechGrammarRuleState : IDispatch
1618 {
1619     [propget, id(DISPID_SGRSRule)]
1620     HRESULT Rule([out, retval] ISpeechGrammarRule **rule);
1621
1622     [propget, id(DISPID_SGRSTransitions)]
1623     HRESULT Transitions([out, retval] ISpeechGrammarRuleStateTransitions **transitions);
1624
1625     [id(DISPID_SGRSAddWordTransition)]
1626     HRESULT AddWordTransition([in] ISpeechGrammarRuleState *state, [in] const BSTR Words,
1627             [in, defaultvalue(" ")] const BSTR separators, [in, defaultvalue(SGLexical)] SpeechGrammarWordType type,
1628             [in, defaultvalue("")] const BSTR name, [in, defaultvalue(0)] long id,
1629             [in, defaultvalue(0)] VARIANT *value,  [in, defaultvalue(1)] float weight);
1630
1631     [id(DISPID_SGRSAddRuleTransition)]
1632     HRESULT AddRuleTransition([in] ISpeechGrammarRuleState *state, [in] ISpeechGrammarRule *rule,
1633             [in, defaultvalue("")] const BSTR name, [in, defaultvalue(0)] long id,
1634             [in, defaultvalue(0)] VARIANT *value, [in, defaultvalue(1)] float weight);
1635
1636     [id(DISPID_SGRSAddSpecialTransition)]
1637     HRESULT AddSpecialTransition([in] ISpeechGrammarRuleState *state, [in] SpeechSpecialTransitionType type,
1638             [in, defaultvalue("")] const BSTR name, [in, defaultvalue(0)] long id,
1639             [in, defaultvalue(0)] VARIANT* value, [in, defaultvalue(1)] float weight);
1640 }
1641
1642 [
1643     object,
1644     uuid(afe719cf-5dd1-44f2-999c-7a399f1cfccc),
1645     dual,
1646     pointer_default(unique)
1647 ]
1648 interface ISpeechGrammarRule : IDispatch
1649 {
1650     [propget, id(DISPID_SGRAttributes)]
1651     HRESULT Attributes([out, retval] SpeechRuleAttributes *attributes);
1652
1653     [propget, id(DISPID_SGRInitialState)]
1654     HRESULT InitialState([out, retval] ISpeechGrammarRuleState **state);
1655
1656     [propget, id(DISPID_SGRName)]
1657     HRESULT Name([out, retval] BSTR *name);
1658
1659     [propget, id(DISPID_SGRId)]
1660     HRESULT Id([out, retval] long *id);
1661
1662     [id(DISPID_SGRClear)]
1663     HRESULT Clear();
1664
1665     [id(DISPID_SGRAddResource)]
1666     HRESULT AddResource([in] const BSTR name, [in] const BSTR value);
1667
1668     [id(DISPID_SGRAddState)]
1669     HRESULT AddState([out, retval] ISpeechGrammarRuleState **state);
1670 }
1671
1672 typedef [hidden] enum DISPIDSPTSI
1673 {
1674     DISPIDSPTSI_ActiveOffset = 1,
1675     DISPIDSPTSI_ActiveLength,
1676     DISPIDSPTSI_SelectionOffset,
1677     DISPIDSPTSI_SelectionLength
1678 } DISPIDSPTSI;
1679
1680 [
1681     object,
1682     uuid(3b9c7e7a-6eee-4ded-9092-11657279adbe),
1683     dual,
1684     pointer_default(unique)
1685 ]
1686 interface ISpeechTextSelectionInformation : IDispatch
1687 {
1688     [propput, id(DISPIDSPTSI_ActiveOffset)]
1689     HRESULT ActiveOffset([in] long offset);
1690     [propget, id(DISPIDSPTSI_ActiveOffset)]
1691     HRESULT ActiveOffset([out, retval] long *offset);
1692
1693     [propput, id(DISPIDSPTSI_ActiveLength)]
1694     HRESULT ActiveLength([in] long length);
1695     [propget, id(DISPIDSPTSI_ActiveLength)]
1696     HRESULT ActiveLength([out, retval] long *length);
1697
1698     [propput, id(DISPIDSPTSI_SelectionOffset)]
1699     HRESULT SelectionOffset([in] long offset);
1700     [propget, id(DISPIDSPTSI_SelectionOffset)]
1701     HRESULT SelectionOffset([out, retval] long *offset);
1702
1703     [propput, id(DISPIDSPTSI_SelectionLength)]
1704     HRESULT SelectionLength([in] long length);
1705     [propget, id(DISPIDSPTSI_SelectionLength)]
1706     HRESULT SelectionLength([out, retval] long* length);
1707 }
1708
1709 typedef [hidden] enum DISPID_SpeechGrammarRules
1710 {
1711     DISPID_SGRsCount = 1,
1712     DISPID_SGRsDynamic,
1713     DISPID_SGRsAdd,
1714     DISPID_SGRsCommit,
1715     DISPID_SGRsCommitAndSave,
1716     DISPID_SGRsFindRule,
1717     DISPID_SGRsItem = DISPID_VALUE,
1718     DISPID_SGRs_NewEnum = DISPID_NEWENUM
1719 } DISPID_SpeechGrammarRules;
1720
1721 [
1722     object,
1723     uuid(6ffa3b44-fc2d-40d1-8afc-32911c7f1ad1),
1724     dual,
1725     pointer_default(unique)
1726 ]
1727 interface ISpeechGrammarRules : IDispatch
1728 {
1729     [propget, id(DISPID_SGRsCount)]
1730     HRESULT Count([out, retval] long *count);
1731
1732     [id(DISPID_SGRsFindRule)]
1733     HRESULT FindRule([in] VARIANT id, [out, retval] ISpeechGrammarRule **rule);
1734
1735     [id(DISPID_SGRsItem)]
1736     HRESULT Item([in] long index, [out, retval] ISpeechGrammarRule **rule);
1737
1738     [id(DISPID_SGRs_NewEnum), propget, restricted]
1739     HRESULT _NewEnum([out, retval] IUnknown **enum_var);
1740
1741     [propget, id(DISPID_SGRsDynamic)]
1742     HRESULT Dynamic([out, retval] VARIANT_BOOL *dynamic);
1743
1744     [id(DISPID_SGRsAdd)]
1745     HRESULT Add([in] BSTR name, [in] SpeechRuleAttributes attributes,
1746             [in, defaultvalue(0)] long id, [out, retval] ISpeechGrammarRule **rule);
1747
1748     [id(DISPID_SGRsCommit)]
1749     HRESULT Commit(void);
1750
1751     [id(DISPID_SGRsCommitAndSave)]
1752     HRESULT CommitAndSave([out] BSTR *text, [out, retval] VARIANT *stream);
1753 }
1754
1755 [
1756     object,
1757     uuid(b6d6f79f-2158-4e50-b5bc-9a9ccd852a09),
1758     dual,
1759     pointer_default(unique)
1760 ]
1761 interface ISpeechRecoGrammar : IDispatch
1762 {
1763     [propget, id(DISPID_SRGId)]
1764     HRESULT Id([out, retval] VARIANT *id);
1765
1766     [propget, id(DISPID_SRGRecoContext)]
1767     HRESULT RecoContext([out, retval] ISpeechRecoContext **context);
1768
1769     [propput, id(DISPID_SRGState)]
1770     HRESULT State([in] SpeechGrammarState state);
1771     [propget, id(DISPID_SRGState)]
1772     HRESULT State([out, retval] SpeechGrammarState *state);
1773
1774     [propget, id(DISPID_SRGRules)]
1775     HRESULT Rules([out, retval] ISpeechGrammarRules **rules);
1776
1777     [id(DISPID_SRGReset)]
1778     HRESULT Reset([in, defaultvalue(0)] SpeechLanguageId language);
1779
1780     [id(DISPID_SRGCmdLoadFromFile)]
1781     HRESULT CmdLoadFromFile([in] const BSTR filename, [in, defaultvalue(SLOStatic)] SpeechLoadOption option);
1782
1783     [id(DISPID_SRGCmdLoadFromObject)]
1784     HRESULT CmdLoadFromObject([in]const BSTR classid, [in] const BSTR grammarname, [in, defaultvalue(SLOStatic)] SpeechLoadOption option);
1785
1786     [id(DISPID_SRGCmdLoadFromResource)]
1787     HRESULT CmdLoadFromResource([in]long mod, [in] VARIANT name, [in] VARIANT type, [in] SpeechLanguageId language,
1788             [in, defaultvalue(SLOStatic)] SpeechLoadOption option);
1789
1790     [id(DISPID_SRGCmdLoadFromMemory)]
1791     HRESULT CmdLoadFromMemory([in] VARIANT data, [in, defaultvalue(SLOStatic)] SpeechLoadOption option);
1792
1793     [id(DISPID_SRGCmdLoadFromProprietaryGrammar)]
1794     HRESULT CmdLoadFromProprietaryGrammar([in] const BSTR guid, [in] const BSTR string, [in] VARIANT data,
1795                     [in, defaultvalue(SLOStatic)] SpeechLoadOption option);
1796
1797     [id(DISPID_SRGCmdSetRuleState)]
1798     HRESULT CmdSetRuleState([in] const BSTR name, [in] SpeechRuleState state);
1799
1800     [id(DISPID_SRGCmdSetRuleIdState)]
1801     HRESULT CmdSetRuleIdState([in] long rule, [in] SpeechRuleState State);
1802
1803     [id(DISPID_SRGDictationLoad)]
1804     HRESULT DictationLoad([in, defaultvalue("")] const BSTR topic, [in, defaultvalue(SLOStatic)] SpeechLoadOption option);
1805
1806     [id(DISPID_SRGDictationUnload)]
1807     HRESULT DictationUnload(void);
1808
1809     [id(DISPID_SRGDictationSetState)]
1810     HRESULT DictationSetState([in] SpeechRuleState State);
1811
1812     [id(DISPID_SRGSetWordSequenceData)]
1813     HRESULT SetWordSequenceData([in] const BSTR text, [in] long length, [in] ISpeechTextSelectionInformation *info);
1814
1815     [id(DISPID_SRGSetTextSelection)]
1816     HRESULT SetTextSelection([in] ISpeechTextSelectionInformation *info);
1817
1818     [id(DISPID_SRGIsPronounceable)]
1819     HRESULT IsPronounceable([in] const BSTR word, [out, retval] SpeechWordPronounceable *pronounceable);
1820 }
1821
1822 [
1823     object,
1824     uuid(580aa49d-7e1e-4809-b8e2-57da806104b8),
1825     dual,
1826     pointer_default(unique)
1827 ]
1828 interface ISpeechRecoContext : IDispatch
1829 {
1830     [propget, id(DISPID_SRCRecognizer)]
1831     HRESULT Recognizer([out,retval] ISpeechRecognizer **recognizer);
1832
1833     [propget, id(DISPID_SRCAudioInInterferenceStatus)]
1834     HRESULT AudioInputInterferenceStatus([out,retval] SpeechInterference *interference);
1835
1836     [propget, id(DISPID_SRCRequestedUIType)]
1837     HRESULT RequestedUIType([out,retval] BSTR *type );
1838
1839     [propputref, id(DISPID_SRCVoice)]
1840     HRESULT Voice([in] ISpeechVoice *voice);
1841     [propget, id(DISPID_SRCVoice)]
1842     HRESULT Voice([out,retval] ISpeechVoice **voice);
1843
1844     [propput, hidden, id(DISPID_SRAllowVoiceFormatMatchingOnNextSet)]
1845     HRESULT AllowVoiceFormatMatchingOnNextSet([in] VARIANT_BOOL allow);
1846     [propget, hidden, id(DISPID_SRAllowVoiceFormatMatchingOnNextSet)]
1847     HRESULT AllowVoiceFormatMatchingOnNextSet([out,retval] VARIANT_BOOL *allow);
1848
1849     [propput, id(DISPID_SRCVoicePurgeEvent)]
1850     HRESULT VoicePurgeEvent([in] SpeechRecoEvents interest);
1851     [propget, id(DISPID_SRCVoicePurgeEvent)]
1852     HRESULT VoicePurgeEvent([out,retval] SpeechRecoEvents *interest);
1853
1854     [propput, id(DISPID_SRCEventInterests)]
1855     HRESULT EventInterests([in] SpeechRecoEvents interest);
1856     [propget, id(DISPID_SRCEventInterests)]
1857     HRESULT EventInterests([out,retval] SpeechRecoEvents *interest);
1858
1859     [propput, id(DISPID_SRCCmdMaxAlternates)]
1860     HRESULT CmdMaxAlternates([in] long alternates);
1861     [propget, id(DISPID_SRCCmdMaxAlternates)]
1862     HRESULT CmdMaxAlternates([out,retval] long *alternates);
1863
1864     [propput, id(DISPID_SRCState)]
1865     HRESULT State([in] SpeechRecoContextState state);
1866     [propget, id(DISPID_SRCState)]
1867     HRESULT State([out,retval] SpeechRecoContextState *state);
1868
1869     [propput, id(DISPID_SRCRetainedAudio)]
1870     HRESULT RetainedAudio([in] SpeechRetainedAudioOptions option);
1871     [propget, id(DISPID_SRCRetainedAudio)]
1872     HRESULT RetainedAudio([out,retval] SpeechRetainedAudioOptions *option);
1873
1874     [propputref, id(DISPID_SRCRetainedAudioFormat)]
1875     HRESULT RetainedAudioFormat([in] ISpeechAudioFormat *format);
1876     [propget, id(DISPID_SRCRetainedAudioFormat)]
1877     HRESULT RetainedAudioFormat([out,retval] ISpeechAudioFormat **format);
1878
1879     [id(DISPID_SRCPause)]
1880     HRESULT Pause(void);
1881
1882     [id(DISPID_SRCResume)]
1883     HRESULT Resume(void);
1884
1885     [id(DISPID_SRCCreateGrammar)]
1886     HRESULT CreateGrammar([in, defaultvalue(0)] VARIANT id, [out,retval] ISpeechRecoGrammar **grammar);
1887
1888     [id(DISPID_SRCCreateResultFromMemory)]
1889     HRESULT CreateResultFromMemory([in] VARIANT *block, [out,retval] ISpeechRecoResult **result);
1890
1891     [id(DISPID_SRCBookmark)]
1892     HRESULT Bookmark([in] SpeechBookmarkOptions options, [in] VARIANT pos, [in] VARIANT bookmark);
1893
1894     [id(DISPID_SRCSetAdaptationData)]
1895     HRESULT SetAdaptationData([in] BSTR adaptation);
1896 }
1897
1898 typedef [hidden] enum DISPID_SpeechRecognizer
1899 {
1900     DISPID_SRRecognizer = 1,
1901     DISPID_SRAllowAudioInputFormatChangesOnNextSet,
1902     DISPID_SRAudioInput,
1903     DISPID_SRAudioInputStream,
1904     DISPID_SRIsShared,
1905     DISPID_SRState,
1906     DISPID_SRStatus,
1907     DISPID_SRProfile,
1908     DISPID_SREmulateRecognition,
1909     DISPID_SRCreateRecoContext,
1910     DISPID_SRGetFormat,
1911     DISPID_SRSetPropertyNumber,
1912     DISPID_SRGetPropertyNumber,
1913     DISPID_SRSetPropertyString,
1914     DISPID_SRGetPropertyString,
1915     DISPID_SRIsUISupported,
1916     DISPID_SRDisplayUI,
1917     DISPID_SRGetRecognizers,
1918     DISPID_SVGetAudioInputs,
1919     DISPID_SVGetProfiles
1920 } DISPID_SpeechRecognizer;
1921
1922 [
1923     object,
1924     uuid(2d5f1c0c-bd75-4b08-9478-3b11fea2586c),
1925     dual,
1926     pointer_default(unique)
1927 ]
1928 interface ISpeechRecognizer : IDispatch
1929 {
1930     [propputref, id(DISPID_SRRecognizer)]
1931     HRESULT Recognizer([in]ISpeechObjectToken *recognizer);
1932     [propget, id(DISPID_SRRecognizer)]
1933     HRESULT Recognizer([out,retval]ISpeechObjectToken **recognizer);
1934
1935     [propput, hidden, id(DISPID_SRAllowAudioInputFormatChangesOnNextSet)]
1936     HRESULT AllowAudioInputFormatChangesOnNextSet([in] VARIANT_BOOL allow);
1937     [propget, hidden, id(DISPID_SRAllowAudioInputFormatChangesOnNextSet)]
1938     HRESULT AllowAudioInputFormatChangesOnNextSet([out,retval] VARIANT_BOOL *allow);
1939
1940     [propputref, id(DISPID_SRAudioInput)]
1941     HRESULT AudioInput([in,defaultvalue(0)] ISpeechObjectToken *input);
1942     [propget, id(DISPID_SRAudioInput)]
1943     HRESULT AudioInput([out,retval] ISpeechObjectToken **input);
1944
1945     [propputref, id(DISPID_SRAudioInputStream)]
1946     HRESULT AudioInputStream([in,defaultvalue(0)] ISpeechBaseStream *input);
1947     [propget, id(DISPID_SRAudioInputStream)]
1948     HRESULT AudioInputStream([out,retval] ISpeechBaseStream **input);
1949
1950     [propget, id(DISPID_SRIsShared)]
1951     HRESULT IsShared([out,retval] VARIANT_BOOL *shared);
1952
1953     [propput, id(DISPID_SRState)]
1954     HRESULT State([in] SpeechRecognizerState state);
1955     [propget, id(DISPID_SRState)]
1956     HRESULT State([out,retval] SpeechRecognizerState *state);
1957
1958     [propget, id(DISPID_SRStatus)]
1959     HRESULT Status([out,retval] ISpeechRecognizerStatus **status);
1960
1961     [propputref, id(DISPID_SRProfile)]
1962     HRESULT Profile([in,defaultvalue(0)] ISpeechObjectToken *profile);
1963     [propget, id(DISPID_SRProfile)]
1964     HRESULT Profile([out,retval] ISpeechObjectToken **profile);
1965
1966     [id(DISPID_SREmulateRecognition)]
1967     HRESULT EmulateRecognition([in] VARIANT elements, [in, defaultvalue(NULL)] VARIANT *attributes,
1968                                 [in, defaultvalue(0)] long id);
1969
1970     [id(DISPID_SRCreateRecoContext)]
1971     HRESULT CreateRecoContext([out,retval] ISpeechRecoContext **ncontext);
1972
1973     [id(DISPID_SRGetFormat)]
1974     HRESULT GetFormat([in] SpeechFormatType speechtype, [out,retval] ISpeechAudioFormat **audioformat);
1975
1976     [hidden, id(DISPID_SRSetPropertyNumber)]
1977     HRESULT SetPropertyNumber([in] const BSTR name, [in] long value, [out,retval] VARIANT_BOOL *supported);
1978
1979     [hidden, id(DISPID_SRGetPropertyNumber)]
1980     HRESULT GetPropertyNumber([in] const BSTR name, [in,out] long *value, [out,retval] VARIANT_BOOL *supported);
1981
1982     [hidden, id(DISPID_SRSetPropertyString)]
1983     HRESULT SetPropertyString([in] const BSTR name, [in] const BSTR value, [out,retval] VARIANT_BOOL *supported);
1984
1985     [hidden, id(DISPID_SRGetPropertyString)]
1986     HRESULT GetPropertyString([in] const BSTR name, [in,out] BSTR *value, [out,retval] VARIANT_BOOL *supported);
1987
1988     [id(DISPID_SRIsUISupported)]
1989     HRESULT IsUISupported([in] const BSTR type, [in, defaultvalue(NULL)] const VARIANT *data,
1990                           [out,retval] VARIANT_BOOL *supported);
1991
1992     [id(DISPID_SRDisplayUI)]
1993     HRESULT DisplayUI( [in] long hWnd, [in] BSTR title, [in] const BSTR type, [in, defaultvalue(NULL)] const VARIANT *data);
1994
1995     [id(DISPID_SRGetRecognizers)]
1996     HRESULT GetRecognizers([in, defaultvalue("")] BSTR required, [in, defaultvalue("")] BSTR optional,
1997                                 [out,retval] ISpeechObjectTokens **tokens);
1998
1999     [id(DISPID_SVGetAudioInputs)]
2000     HRESULT GetAudioInputs([in, defaultvalue("")] BSTR required,  [in, defaultvalue("")] BSTR optional,
2001                                 [out,retval] ISpeechObjectTokens **tokens);
2002
2003     [id(DISPID_SVGetProfiles)]
2004     HRESULT GetProfiles([in, defaultvalue("")] BSTR required,  [in, defaultvalue("")] BSTR optional,
2005                                 [out,retval] ISpeechObjectTokens **tokens);
2006
2007 }
2008
2009 typedef enum SpeechStreamFileMode
2010 {
2011     SSFMOpenForRead = SPFM_OPEN_READONLY,
2012     SSFMOpenReadWrite = SPFM_OPEN_READWRITE,
2013     SSFMCreate = SPFM_CREATE,
2014     SSFMCreateForWrite = SPFM_CREATE_ALWAYS,
2015 } SpeechStreamFileMode;
2016
2017 typedef [hidden] enum DISPID_SpeechFileStream
2018 {
2019     DISPID_SFSOpen = 100,
2020     DISPID_SFSClose
2021 } DISPID_SpeechFileStream;
2022
2023 [
2024     object,
2025     uuid(af67f125-ab39-4e93-b4a2-cc2e66e182a7),
2026     dual,
2027     pointer_default(unique)
2028 ]
2029 interface ISpeechFileStream : ISpeechBaseStream
2030 {
2031     [id(DISPID_SFSOpen)]
2032     HRESULT Open([in] BSTR filename, [in, defaultvalue(SSFMOpenForRead)] SpeechStreamFileMode mode,
2033                  [in, defaultvalue(0)] VARIANT_BOOL events);
2034     [id(DISPID_SFSClose)]
2035     HRESULT Close(void);
2036 };