2 * Speech API (SAPI) IDL file.
4 * Copyright (C) 2017 Huw Davies
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
25 #define threading
(model
)
27 #define vi_progid
(str
)
31 typedef [restricted, hidden] struct WAVEFORMATEX
36 DWORD nAvgBytesPerSec
;
42 cpp_quote
("#include <mmsystem.h>")
45 cpp_quote
("#if defined(__cplusplus)")
46 cpp_quote
("interface ISpNotifyCallback")
48 cpp_quote
("virtual HRESULT STDMETHODCALLTYPE NotifyCallback(WPARAM wParam, LPARAM lParam) = 0;")
51 typedef void * ISpNotifyCallback
;
55 typedef void * SPNOTIFYCALLBACK
;
56 typedef void * SPSTATEHANDLE
;
59 typedef [restricted, hidden] struct SPEVENT
64 ULONGLONG ullAudioStreamOffset
;
69 cpp_quote
("typedef void __stdcall SPNOTIFYCALLBACK(WPARAM wParam, LPARAM lParam);")
70 cpp_quote
("DECLARE_HANDLE(SPSTATEHANDLE);")
72 const ULONG SP_MAX_LANGIDS
= 20;
74 typedef [restricted, hidden] struct SPEVENTSOURCEINFO
76 ULONGLONG ullEventInterest
;
77 ULONGLONG ullQueuedInterest
;
81 typedef [hidden] enum SPGRAMMARWORDTYPE
86 SPWT_LEXICAL_NO_SPECIAL_CHARS
89 typedef [hidden] struct tagSPPROPERTYINFO
93 const WCHAR
*pszValue
;
97 typedef [hidden] enum SPDATAKEYLOCATION
99 SPDKL_DefaultLocation
= 0,
100 SPDKL_CurrentUser
= 1,
101 SPDKL_LocalMachine
= 2,
102 SPDKL_CurrentConfig
= 5
105 typedef [hidden] enum SPLOADOPTIONS
111 typedef [hidden] enum SPRULESTATE
115 SPRS_ACTIVE_WITH_AUTO_PAUSE
= 3,
116 SPRS_ACTIVE_USER_DELIMITED
= 4
119 typedef [hidden] enum SPGRAMMARSTATE
126 typedef [hidden] struct SPBINARYGRAMMAR
128 ULONG ulTotalSerializedSize
;
131 typedef [hidden] struct tagSPTEXTSELECTIONINFO
133 ULONG ulStartActiveOffset
;
134 ULONG cchActiveChars
;
135 ULONG ulStartSelection
;
137 } SPTEXTSELECTIONINFO
;
139 typedef [hidden] enum SPWORDPRONOUNCEABLE
141 SPWP_UNKNOWN_WORD_UNPRONOUNCEABLE
,
142 SPWP_UNKNOWN_WORD_PRONOUNCEABLE
,
143 SPWP_KNOWN_WORD_PRONOUNCEABLE
144 } SPWORDPRONOUNCEABLE
;
146 typedef [hidden] enum SPINTERFERENCE
149 SPINTERFERENCE_NOISE
,
150 SPINTERFERENCE_NOSIGNAL
,
151 SPINTERFERENCE_TOOLOUD
,
152 SPINTERFERENCE_TOOQUIET
,
153 SPINTERFERENCE_TOOFAST
,
154 SPINTERFERENCE_TOOSLOW
157 typedef [hidden] enum SPVISEMES
183 typedef [hidden] enum SPEVENTENUM
186 SPEI_START_INPUT_STREAM
= 1,
187 SPEI_END_INPUT_STREAM
= 2,
188 SPEI_VOICE_CHANGE
= 3,
189 SPEI_TTS_BOOKMARK
= 4,
190 SPEI_WORD_BOUNDARY
= 5,
192 SPEI_SENTENCE_BOUNDARY
= 7,
194 SPEI_TTS_AUDIO_LEVEL
= 9,
195 SPEI_TTS_PRIVATE
= 15,
200 SPEI_END_SR_STREAM
= 34,
201 SPEI_SOUND_START
= 35,
203 SPEI_PHRASE_START
= 37,
204 SPEI_RECOGNITION
= 38,
205 SPEI_HYPOTHESIS
= 39,
206 SPEI_SR_BOOKMARK
= 40,
207 SPEI_PROPERTY_NUM_CHANGE
= 41,
208 SPEI_PROPERTY_STRING_CHANGE
= 42,
209 SPEI_FALSE_RECOGNITION
= 43,
210 SPEI_INTERFERENCE
= 44,
211 SPEI_REQUEST_UI
= 45,
212 SPEI_RECO_STATE_CHANGE
= 46,
213 SPEI_ADAPTATION
= 47,
214 SPEI_START_SR_STREAM
= 48,
215 SPEI_RECO_OTHER_CONTEXT
= 49,
216 SPEI_SR_AUDIO_LEVEL
= 50,
217 SPEI_SR_RETAINEDAUDIO
= 51,
218 SPEI_SR_PRIVATE
= 52,
219 SPEI_ACTIVE_CATEGORY_CHANGED
= 53,
229 typedef [hidden] enum SPCONTEXTSTATE
235 typedef [hidden] enum SPVPRIORITY
242 typedef [hidden] enum SPRECOSTATE
247 SPRST_INACTIVE_WITH_PURGE
,
251 typedef [hidden] enum SPWAVEFORMATTYPE
255 } SPSTREAMFORMATTYPE
;
257 typedef [restricted, hidden] struct SPRECOCONTEXTSTATUS
259 SPINTERFERENCE eInterference
;
260 WCHAR szRequestTypeOfUI
[255];
263 } SPRECOCONTEXTSTATUS
;
265 typedef [hidden] enum SPAUDIOOPTIONS
271 typedef [hidden] struct SPSERIALIZEDRESULT
273 ULONG ulSerializedSize
;
274 } SPSERIALIZEDRESULT
;
276 typedef [hidden] enum SPDISPLYATTRIBUTES
278 SPAF_ONE_TRAILING_SPACE
= 0x02,
279 SPAF_TWO_TRAILING_SPACES
= 0x04,
280 SPAF_CONSUME_LEADING_SPACES
= 0x08,
282 } SPDISPLAYATTRIBUTES
;
284 typedef [hidden] enum SPBOOKMARKOPTIONS
290 typedef [hidden] enum _SPAUDIOSTATE
298 typedef [hidden] enum SPRUNSTATE
300 SPRS_DONE
= (1L << 0),
301 SPRS_IS_SPEAKING
= (1L << 1)
304 typedef [hidden] enum SPEAKFLAGS
307 SPF_ASYNC
= (1L << 0),
308 SPF_PURGEBEFORESPEAK
= (1L << 1),
309 SPF_IS_FILENAME
= (1L << 2),
310 SPF_IS_XML
= (1L << 3),
311 SPF_IS_NOT_XML
= (1L << 4),
312 SPF_PERSIST_XML
= (1L << 5),
313 SPF_NLP_SPEAK_PUNC
= (1L << 6),
314 SPF_PARSE_SAPI
= (1L << 7),
315 SPF_PARSE_SSML
= (1L << 8),
316 SPF_PARSE_AUTODETECT
= 0,
317 SPF_NLP_MASK
= (SPF_NLP_SPEAK_PUNC
),
318 SPF_PARSE_MASK
= (SPF_PARSE_SAPI|SPF_PARSE_SSML
),
319 SPF_VOICE_MASK
= (SPF_ASYNC|SPF_PURGEBEFORESPEAK|SPF_IS_FILENAME|SPF_IS_XML|SPF_IS_NOT_XML|SPF_NLP_MASK|SPF_PERSIST_XML|SPF_PARSE_MASK
),
320 SPF_UNUSED_FLAGS
= ~
(SPF_VOICE_MASK
)
323 typedef [hidden] enum SPCFGRULEATTRIBUTES
325 SPRAF_TopLevel
= (1 << 0),
326 SPRAF_Active
= (1 << 1),
327 SPRAF_Export
= (1 << 2),
328 SPRAF_Import
= (1 << 3),
329 SPRAF_Interpreter
= (1 << 4),
330 SPRAF_Dynamic
= (1 << 5),
331 SPRAF_Root
= (1 << 6),
332 SPRAF_AutoPause
= (1 << 16),
333 SPRAF_UserDelimited
= (1 << 17)
334 } SPCFGRULEATTRIBUTES
;
336 typedef [hidden] enum SPPHRASERNG
338 SPPR_ALL_ELEMENTS
= -1
341 typedef [hidden] enum SPVALUETYPE
343 SPDF_PROPERTY
= 0x00000001,
344 SPDF_REPLACEMENT
= 0x00000002,
345 SPDF_RULE
= 0x00000004,
346 SPDF_DISPLAYTEXT
= 0x00000008,
347 SPDF_LEXICALFORM
= 0x00000010,
348 SPDF_PRONUNCIATION
= 0x00000020,
349 SPDF_AUDIO
= 0x00000040,
350 SPDF_ALTERNATES
= 0x00000080,
351 SPDF_ALL
= 0x000000ff
354 typedef [hidden] enum SPSTREAMFORMAT
357 SPSF_NoAssignedFormat
= 0,
359 SPSF_NonStandardFormat
,
360 SPSF_ExtendedAudioFormat
,
364 SPSF_8kHz16BitStereo
,
366 SPSF_11kHz8BitStereo
,
368 SPSF_11kHz16BitStereo
,
370 SPSF_12kHz8BitStereo
,
372 SPSF_12kHz16BitStereo
,
374 SPSF_16kHz8BitStereo
,
376 SPSF_16kHz16BitStereo
,
378 SPSF_22kHz8BitStereo
,
380 SPSF_22kHz16BitStereo
,
382 SPSF_24kHz8BitStereo
,
384 SPSF_24kHz16BitStereo
,
386 SPSF_32kHz8BitStereo
,
388 SPSF_32kHz16BitStereo
,
390 SPSF_44kHz8BitStereo
,
392 SPSF_44kHz16BitStereo
,
394 SPSF_48kHz8BitStereo
,
396 SPSF_48kHz16BitStereo
,
397 SPSF_TrueSpeech_8kHz1BitMono
,
398 SPSF_CCITT_ALaw_8kHzMono
,
399 SPSF_CCITT_ALaw_8kHzStereo
,
400 SPSF_CCITT_ALaw_11kHzMono
,
401 SPSF_CCITT_ALaw_11kHzStereo
,
402 SPSF_CCITT_ALaw_22kHzMono
,
403 SPSF_CCITT_ALaw_22kHzStereo
,
404 SPSF_CCITT_ALaw_44kHzMono
,
405 SPSF_CCITT_ALaw_44kHzStereo
,
406 SPSF_CCITT_uLaw_8kHzMono
,
407 SPSF_CCITT_uLaw_8kHzStereo
,
408 SPSF_CCITT_uLaw_11kHzMono
,
409 SPSF_CCITT_uLaw_11kHzStereo
,
410 SPSF_CCITT_uLaw_22kHzMono
,
411 SPSF_CCITT_uLaw_22kHzStereo
,
412 SPSF_CCITT_uLaw_44kHzMono
,
413 SPSF_CCITT_uLaw_44kHzStereo
,
415 SPSF_ADPCM_8kHzStereo
,
416 SPSF_ADPCM_11kHzMono
,
417 SPSF_ADPCM_11kHzStereo
,
418 SPSF_ADPCM_22kHzMono
,
419 SPSF_ADPCM_22kHzStereo
,
420 SPSF_ADPCM_44kHzMono
,
421 SPSF_ADPCM_44kHzStereo
,
422 SPSF_GSM610_8kHzMono
,
423 SPSF_GSM610_11kHzMono
,
424 SPSF_GSM610_22kHzMono
,
425 SPSF_GSM610_44kHzMono
,
429 typedef unsigned short SPPHONEID
;
431 typedef [restricted, hidden] struct SPPHRASEELEMENT
433 ULONG ulAudioTimeOffset
;
434 ULONG ulAudioSizeTime
;
435 ULONG ulAudioStreamOffset
;
436 ULONG ulAudioSizeBytes
;
437 ULONG ulRetainedStreamOffset
;
438 ULONG ulRetainedSizeBytes
;
439 const WCHAR
*pszDisplayText
;
440 const WCHAR
*pszLexicalForm
;
441 const SPPHONEID
*pszPronunciation
;
442 BYTE bDisplayAttributes
;
443 signed char RequiredConfidence
;
444 signed char ActualConfidence
;
446 float SREngineConfidence
;
449 typedef [restricted, hidden] struct SPVOICESTATUS
451 ULONG ulCurrentStream
;
452 ULONG ulLastStreamQueued
;
453 HRESULT hrLastResult
;
454 DWORD dwRunningState
;
455 ULONG ulInputWordPos
;
456 ULONG ulInputWordLen
;
457 ULONG ulInputSentPos
;
458 ULONG ulInputSentLen
;
466 typedef [restricted, hidden] struct SPAUDIOSTATUS
468 long cbFreeBuffSpace
;
469 ULONG cbNonBlockingIO
;
471 ULONGLONG CurSeekPos
;
472 ULONGLONG CurDevicePos
;
477 typedef [restricted, hidden] struct SPRECOGNIZERSTATUS
479 SPAUDIOSTATUS AudioStatus
;
480 ULONGLONG ullRecognitionStreamPos
;
481 ULONG ulStreamNumber
;
485 LANGID aLangID
[SP_MAX_LANGIDS
];
486 ULONGLONG ullRecognitionStreamTime
;
487 } SPRECOGNIZERSTATUS
;
489 typedef [restricted, hidden] struct SPPHRASERULE SPPHRASERULE
;
495 ULONG ulFirstElement
;
496 ULONG ulCountOfElements
;
497 const SPPHRASERULE
* pNextSibling
;
498 const SPPHRASERULE
* pFirstChild
;
499 float SREngineConfidence
;
500 signed char Confidence
;
503 typedef [restricted, hidden] struct SPPHRASEPROPERTY SPPHRASEPROPERTY
;
505 struct SPPHRASEPROPERTY
507 const WCHAR
*pszName
;
509 const WCHAR
*pszValue
;
511 ULONG ulFirstElement
;
512 ULONG ulCountOfElements
;
513 const SPPHRASEPROPERTY
*pNextSibling
;
514 const SPPHRASEPROPERTY
*pFirstChild
;
515 float SREngineConfidence
;
516 signed char Confidence
;
519 typedef [restricted, hidden] struct SPPHRASEREPLACEMENT
521 BYTE bDisplayAttributes
;
522 const WCHAR
*pszReplacementText
;
523 ULONG ulFirstElement
;
524 ULONG ulCountOfElements
;
525 } SPPHRASEREPLACEMENT
;
527 typedef [restricted, hidden] struct SPPHRASE
532 ULONGLONG ullGrammarID
;
533 ULONGLONG ftStartTime
;
534 ULONGLONG ullAudioStreamPosition
;
535 ULONG ulAudioSizeBytes
;
536 ULONG ulRetainedSizeBytes
;
537 ULONG ulAudioSizeTime
;
539 const SPPHRASEPROPERTY
*pProperties
;
540 const SPPHRASEELEMENT
*pElements
;
542 const SPPHRASEREPLACEMENT
*pReplacements
;
544 ULONG ulSREnginePrivateDataSize
;
545 const BYTE *pSREnginePrivateData
;
548 typedef [restricted, hidden] struct SPSERIALIZEDPHRASE
550 ULONG ulSerializedSize
;
551 } SPSERIALIZEDPHRASE
;
553 typedef [restricted, hidden] struct SPRECORESULTTIMES
555 FILETIME ftStreamTime
;
561 typedef [hidden] enum SPFILEMODE
570 typedef [restricted, hidden] struct SPAUDIOBUFFERINFO
572 ULONG ulMsMinNotification
;
573 ULONG ulMsBufferSize
;
577 cpp_quote
("#if defined(__GNUC__)")
579 cpp_quote
("#define SPCAT_AUDIOOUT (const WCHAR []){ 'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','O','u','t','p','u','t',0 }")
580 cpp_quote
("#define SPCAT_AUDIOIN (const WCHAR []){ 'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','I','n','p','u','t',0 }")
581 cpp_quote
("#define SPCAT_VOICES (const WCHAR []){ 'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','V','o','i','c','e','s',0 }")
583 cpp_quote
("#elif defined(_MSC_VER)")
585 cpp_quote
("#define SPCAT_AUDIOOUT L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioOutput\"")
586 cpp_quote
("#define SPCAT_AUDIOIN L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioInput\"")
587 cpp_quote
("#define SPCAT_VOICES L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\Voices\"")
591 cpp_quote
("static const WCHAR SPCAT_AUDIOOUT[] = {'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','O','u','t','p','u','t',0};")
592 cpp_quote
("static const WCHAR SPCAT_AUDIOIN[] = {'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','I','n','p','u','t',0};")
593 cpp_quote
("static const WCHAR SPCAT_VOICES[] = {'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','V','o','i','c','e','s',0};")
597 interface IEnumSpObjectTokens
;
598 interface ISpEventSource
;
599 interface ISpRecoContext
;
600 interface ISpRecognizer
;
601 interface ISpStreamFormat
;
606 uuid(14056581-e16c
-11d2
-bb90
-00c04f8ee6c0
),
607 helpstring("ISpDataKey"),
608 pointer_default(unique),
612 interface ISpDataKey
: IUnknown
614 HRESULT SetData
([in] LPCWSTR pszValueName
,
616 [in] const BYTE *pData
);
617 HRESULT GetData
([in] LPCWSTR pszValueName
,
620 HRESULT SetStringValue
([in] LPCWSTR pszValueName
,
621 [in] LPCWSTR pszValue
);
622 HRESULT GetStringValue
([in] LPCWSTR pszValueName
,
623 [out] LPWSTR
*ppszValue
);
624 HRESULT SetDWORD
([in] LPCWSTR pszValueName
,
626 HRESULT GetDWORD
([in] LPCWSTR pszValueName
,
627 [out] DWORD
*pdwValue
);
628 HRESULT OpenKey
([in] LPCWSTR pszSubKeyName
,
629 [out] ISpDataKey
**ppSubKey
);
630 HRESULT CreateKey
([in] LPCWSTR pszSubKey
,
631 [out] ISpDataKey
**ppSubKey
);
632 HRESULT DeleteKey
([in] LPCWSTR pszSubKey
);
633 HRESULT DeleteValue
([in] LPCWSTR pszValueName
);
634 HRESULT EnumKeys
([in] ULONG Index
,
635 [out] LPWSTR
*ppszSubKeyName
);
636 HRESULT EnumValues
([in] ULONG Index
,
637 [out] LPWSTR
*ppszValueName
);
641 uuid(92a66e2b
-c830
-4149-83df
-6fc2ba1e7a5b
),
642 helpstring("ISpRegDataKey"),
643 pointer_default(unique),
646 interface ISpRegDataKey
: ISpDataKey
648 [local] HRESULT SetKey
([in] HKEY hkey
, [in] BOOL fReadOnly
);
653 uuid(2d3d3845
-39af
-4850-bbf9
-40b49780011d
),
654 helpstring("ISpObjectTokenCategory"),
655 pointer_default(unique),
659 interface ISpObjectTokenCategory
: ISpDataKey
661 HRESULT SetId
([in] LPCWSTR pszCategoryId
,
662 [in] BOOL fCreateIfNotExist
);
663 HRESULT GetId
([out] LPWSTR
*ppszCoMemCategoryId
);
664 HRESULT GetDataKey
([in] SPDATAKEYLOCATION spdkl
,
665 [out] ISpDataKey
**ppDataKey
);
666 HRESULT EnumTokens
([in, string] LPCWSTR pszReqAttribs
,
667 [in, string] LPCWSTR pszOptAttribs
,
668 [out] IEnumSpObjectTokens
**ppEnum
);
669 HRESULT SetDefaultTokenId
([in] LPCWSTR pszTokenId
);
670 HRESULT GetDefaultTokenId
([out] LPWSTR
*ppszCoMemTokenId
);
675 uuid(14056589-e16c
-11d2
-bb90
-00c04f8ee6c0
),
676 helpstring("ISpObjectToken"),
677 pointer_default(unique),
681 interface ISpObjectToken
: ISpDataKey
683 HRESULT SetId
(/*[in]*/ LPCWSTR pszCategoryId
,
684 [in] LPCWSTR pszTokenId
,
685 [in] BOOL fCreateIfNotExist
);
686 HRESULT GetId
([out] LPWSTR
*ppszCoMemTokenId
);
687 HRESULT GetCategory
([out] ISpObjectTokenCategory
**ppTokenCategory
);
688 HRESULT CreateInstance
([in] IUnknown
*pUnkOuter
,
689 [in] DWORD dwClsContext
,
691 [out, iid_is(riid
)] void **ppvObject
);
692 HRESULT GetStorageFileName
([in] REFCLSID clsidCaller
,
693 [in] LPCWSTR pszValueName
,
694 [in, string] LPCWSTR pszFileNameSpecifier
,
696 [out] LPWSTR
*ppszFilePath
);
697 HRESULT RemoveStorageFileName
([in] REFCLSID clsidCaller
,
698 [in] LPCWSTR pszKeyName
,
699 [in] BOOL fDeleteFile
);
700 HRESULT Remove
(/*[in]*/ const CLSID
*pclsidCaller
);
701 [local] HRESULT IsUISupported
([in] LPCWSTR pszTypeOfUI
,
702 [in] void *pvExtraData
,
703 [in] ULONG cbExtraData
,
704 [in] IUnknown
*punkObject
,
705 [out] BOOL
*pfSupported
);
706 [local] HRESULT DisplayUI
([in] HWND hwndParent
,
707 [in] LPCWSTR pszTitle
,
708 [in] LPCWSTR pszTypeOfUI
,
709 [in] void *pvExtraData
,
710 [in] ULONG cbExtraData
,
711 [in] IUnknown
*punkObject
);
712 HRESULT MatchesAttributes
([in] LPCWSTR pszAttributes
,
713 [out] BOOL
*pfMatches
);
718 uuid(06b64f9e
-7fda
-11d2
-b4f2
-00c04f797396
),
719 helpstring("IEnumSpObjectTokens"),
720 pointer_default(unique),
724 interface IEnumSpObjectTokens
: IUnknown
726 HRESULT Next
([in] ULONG celt
,
727 [out, size_is(celt
), length_is(*pceltFetched
)] ISpObjectToken
**pelt
,
728 [out] ULONG
*pceltFetched
);
729 HRESULT Skip
([in] ULONG celt
);
731 HRESULT Clone
([out] IEnumSpObjectTokens
**ppEnum
);
732 HRESULT Item
([in] ULONG Index
,
733 [out] ISpObjectToken
**ppToken
);
734 HRESULT GetCount
([out] ULONG
*pCount
);
739 uuid(93384e18
-5014-43d5
-adbb
-a78e055926bd
),
740 helpstring("ISpResourceManager"),
741 pointer_default(unique),
744 interface ISpResourceManager
: IServiceProvider
746 HRESULT SetObject
([in] REFGUID guidServiceId
,
747 [in] IUnknown
*pUnkObject
);
748 HRESULT GetObject
([in] REFGUID guidServiceId
,
749 [in] REFCLSID ObjectCLSID
,
750 [in] REFIID ObjectIID
,
751 [in] BOOL fReleaseWhenLastExternalRefReleased
,
752 [out, iid_is(ObjectIID
)] void** ppObject
);
757 uuid(1a5c0354
-b621
-4b5a
-8791-d306ed379e53
),
759 pointer_default(unique),
762 interface ISpPhrase
: IUnknown
764 HRESULT GetPhrase
([out] SPPHRASE
**phrase
);
765 HRESULT GetSerializedPhrase
([out] SPSERIALIZEDPHRASE
**phrase
);
766 HRESULT GetText
([in] ULONG start
, [in] ULONG count
, [in] BOOL replacements
,
767 [out] WCHAR
**text
, [out] BYTE *attributes
);
768 HRESULT Discard
([in] DWORD types
);
773 uuid(8fcebc98
-4e49
-4067-9c6c
-d86a0e092e3d
),
775 pointer_default(unique),
778 interface ISpPhraseAlt
: ISpPhrase
780 HRESULT GetAltInfo
(ISpPhrase
**parent
, ULONG
*start
, ULONG
*count
,
787 uuid(20b053be
-e235
-43cd
-9a2a
-8d17a48b7842
),
788 pointer_default(unique),
792 interface ISpRecoResult
: ISpPhrase
794 HRESULT GetResultTimes
([out] SPRECORESULTTIMES
*times
);
796 HRESULT GetAlternates
(
800 [out] ISpPhraseAlt
**phrases
,
801 [out] ULONG
*returned
);
806 [out] ISpStreamFormat
**stream
);
811 [out] ULONG
*number
);
813 HRESULT Serialize
([out] SPSERIALIZEDRESULT
**result
);
815 HRESULT ScaleAudio
([in] const GUID
*format
, [in] const WAVEFORMATEX
*wave
);
817 HRESULT GetRecoContext
([out] ISpRecoContext
*context
);
822 uuid(8137828f
-591a
-4a42
-be58
-49ea7ebaac68
),
823 helpstring("ISpGrammarBuilder Interface"),
824 pointer_default(unique),
828 interface ISpGrammarBuilder
: IUnknown
830 HRESULT ResetGrammar
([in] LANGID language
);
832 HRESULT GetRule
([in] const WCHAR
*rule
,
834 [in] DWORD attributes
,
835 [in] BOOL should_create
,
836 [out] SPSTATEHANDLE
*state
);
837 HRESULT ClearRule
(SPSTATEHANDLE state
);
839 HRESULT CreateNewState
(
840 [in] SPSTATEHANDLE instate
,
841 [out] SPSTATEHANDLE
*outstate
);
843 HRESULT AddWordTransition
(
844 [in] SPSTATEHANDLE from_state
,
845 [in] SPSTATEHANDLE to_state
,
846 [in] const WCHAR
*value
,
847 [in] const WCHAR
*separators
,
848 [in] SPGRAMMARWORDTYPE type
,
850 [in] const SPPROPERTYINFO
*info
);
852 HRESULT AddRuleTransition
(
853 [in] SPSTATEHANDLE from_state
,
854 [in] SPSTATEHANDLE to_state
,
855 [in] SPSTATEHANDLE rule
,
857 [in] const SPPROPERTYINFO
*info
);
859 HRESULT AddResource
([in] SPSTATEHANDLE state
,
860 [in] const WCHAR
*name
,
861 [in] const WCHAR
*value
);
863 HRESULT Commit
([in] DWORD reserved
);
868 uuid(2177db29
-7f45
-47d0
-8554-067e91c80502
),
869 pointer_default(unique),
873 interface ISpRecoGrammar
: ISpGrammarBuilder
875 HRESULT GetGrammarId
([out] ULONGLONG
*grammar
);
876 HRESULT GetRecoContext
([out] ISpRecoContext
**context
);
878 HRESULT LoadCmdFromFile
([in, string] const WCHAR
* pszFileName
, [in] SPLOADOPTIONS options
);
879 HRESULT LoadCmdFromObject
([in] REFCLSID rcid
, [in, string] const WCHAR
* pszGrammarName
, [in] SPLOADOPTIONS options
);
880 HRESULT LoadCmdFromResource
([in] HMODULE hmod
,
881 [in, string] const WCHAR
*name
,
882 [in, string] const WCHAR
*type
,
884 [in] SPLOADOPTIONS options
);
885 HRESULT LoadCmdFromMemory
([in] const SPBINARYGRAMMAR
*grammar
, [in] SPLOADOPTIONS options
);
886 HRESULT LoadCmdFromProprietaryGrammar
(
888 [in, string] const WCHAR
*param
,
889 [in] const void *data
,
891 [in] SPLOADOPTIONS options
);
892 HRESULT SetRuleState
([in, string] const WCHAR
*name
, [in] void *reserved
,
893 [in] SPRULESTATE state
);
894 HRESULT SetRuleIdState
([in] ULONG rule
, [in] SPRULESTATE state
);
896 HRESULT LoadDictation
([in, string] const WCHAR
*name
, [in] SPLOADOPTIONS options
);
897 HRESULT UnloadDictation
();
898 HRESULT SetDictationState
([in] SPRULESTATE state
);
900 HRESULT SetWordSequenceData
([in] const WCHAR
*text
, [in] ULONG count
, [in] const SPTEXTSELECTIONINFO
*info
);
901 HRESULT SetTextSelection
([in] const SPTEXTSELECTIONINFO
*info
);
903 HRESULT IsPronounceable
([in, string] const WCHAR
*word
, [out] SPWORDPRONOUNCEABLE
*pronounceable
);
905 HRESULT SetGrammarState
([in] SPGRAMMARSTATE state
);
907 HRESULT SaveCmd
([in] IStream
*stream
, [out, optional] WCHAR
**error
);
909 HRESULT GetGrammarState
([out] SPGRAMMARSTATE
*state
);
914 uuid(259684dc
-37c3
-11d2
-9603-00c04f8ee628
),
915 pointer_default(unique),
918 interface ISpNotifySink
: IUnknown
920 HRESULT Notify
(void);
925 uuid(5eff4aef
-8487-11d2
-961c
-00c04f8ee628
),
926 pointer_default(unique),
929 interface ISpNotifySource
: IUnknown
931 HRESULT SetNotifySink
([in] ISpNotifySink
*sink
);
932 [local] HRESULT SetNotifyWindowMessage
(
937 [local] HRESULT SetNotifyCallbackFunction
(
938 [in] SPNOTIFYCALLBACK
*callback,
941 [local] HRESULT SetNotifyCallbackInterface
(
942 [in] ISpNotifyCallback
*callback,
945 [local] HRESULT SetNotifyWin32Event
(void);
946 [local] HRESULT WaitForNotifyEvent
([in] DWORD milliseconds
);
947 [local] HANDLE GetNotifyEventHandle
();
952 uuid(be7a9cce
-5f9e
-11d2
-960f
-00c04f8ee628
),
953 pointer_default(unique),
957 interface ISpEventSource
: ISpNotifySource
959 HRESULT SetInterest
([in] ULONGLONG event
, [in] ULONGLONG queued
);
960 HRESULT GetEvents
([in] ULONG count
,
961 [out, size_is(count
)] SPEVENT
*array
,
962 [out] ULONG
*fetched
);
963 HRESULT GetInfo
([out] SPEVENTSOURCEINFO
*info
);
968 uuid(f740a62f
-7c15
-489e-8234-940a33d9272d
),
969 pointer_default(unique),
973 interface ISpRecoContext
: ISpEventSource
975 HRESULT GetRecognizer
([out] ISpRecognizer
**recognizer
);
977 HRESULT CreateGrammar
([in] ULONGLONG grammar
, [out] ISpRecoGrammar
**spgrammar
);
979 HRESULT GetStatus
([out] SPRECOCONTEXTSTATUS
*status
);
981 HRESULT GetMaxAlternates
([in] ULONG
*alternates
);
982 HRESULT SetMaxAlternates
([in] ULONG alternates
);
984 HRESULT SetAudioOptions
([in] SPAUDIOOPTIONS options
, [in] const GUID
*format
, [in] const WAVEFORMATEX
*wave
);
985 HRESULT GetAudioOptions
([in] SPAUDIOOPTIONS
*options
, [out] GUID
*format
, [out] WAVEFORMATEX
**wave
);
987 HRESULT DeserializeResult
([in] const SPSERIALIZEDRESULT
*serialized
, [out] ISpRecoResult
**result
);
989 HRESULT Bookmark
([in] SPBOOKMARKOPTIONS options
, [in] ULONGLONG position
, [in] LPARAM event
);
991 HRESULT SetAdaptationData
([in, string] const WCHAR
*data
, [in] const ULONG count
);
993 HRESULT Pause
(DWORD reserved
);
994 HRESULT Resume
(DWORD reserved
);
996 HRESULT SetVoice
([in] ISpVoice
*voice
, [in] BOOL changes
);
997 HRESULT GetVoice
([out] ISpVoice
**voice
);
998 HRESULT SetVoicePurgeEvent
([in] ULONGLONG interest
);
999 HRESULT GetVoicePurgeEvent
([out] ULONGLONG
*interest
);
1001 HRESULT SetContextState
([in] SPCONTEXTSTATE state
);
1002 HRESULT GetContextState
([in] SPCONTEXTSTATE
*state
);
1007 uuid(6c44df74
-72b9
-4992-a1ec
-ef996e0422d4
),
1008 pointer_default(unique),
1011 interface ISpVoice
: ISpEventSource
1013 HRESULT SetOutput
([in] IUnknown
*unk
, [in] BOOL changes
);
1014 HRESULT GetOutputObjectToken
([out] ISpObjectToken
**token
);
1015 HRESULT GetOutputStream
([out] ISpStreamFormat
**stream
);
1017 HRESULT Pause
(void);
1018 HRESULT Resume
(void);
1020 HRESULT SetVoice
([in] ISpObjectToken
*token
);
1021 HRESULT GetVoice
([out] ISpObjectToken
**token
);
1023 HRESULT Speak
([in, string] const WCHAR
*pwcs
,
1025 [out] ULONG
*number
);
1026 HRESULT SpeakStream
([in] IStream
*stream
,
1028 [out] ULONG
*number
);
1031 [out] SPVOICESTATUS
*status
,
1032 [out, string] WCHAR
**bookmark
);
1034 HRESULT Skip
([in,string] const WCHAR
*type
, [in] long items
, [out] ULONG
*skipped
);
1036 HRESULT SetPriority
([in] SPVPRIORITY priority
);
1037 HRESULT GetPriority
([out] SPVPRIORITY
* priority
);
1039 HRESULT SetAlertBoundary
([in] SPEVENTENUM boundary
);
1040 HRESULT GetAlertBoundary
([out] SPEVENTENUM
* boundary
);
1042 HRESULT SetRate
([in] long adjust
);
1043 HRESULT GetRate
([out] long *adjust
);
1045 HRESULT SetVolume
([in] USHORT volume
);
1046 HRESULT GetVolume
([out] USHORT
*volume
);
1048 HRESULT WaitUntilDone
([in] ULONG timeout
);
1050 HRESULT SetSyncSpeakTimeout
([in] ULONG timeout
);
1051 HRESULT GetSyncSpeakTimeout
([out] ULONG
*timeout
);
1053 [local] HANDLE SpeakCompleteEvent
();
1055 [local] HRESULT IsUISupported
(
1056 [in] const WCHAR
*type
,
1059 [out] BOOL
*supported
);
1060 [local] HRESULT DisplayUI
(
1062 [in] const WCHAR
*title
,
1063 [in] const WCHAR
*type
,
1070 uuid(bed530be
-2606-4f4d
-a1c0
-54c5cda5566f
),
1071 pointer_default(unique),
1074 interface ISpStreamFormat
: IStream
1076 HRESULT GetFormat
(GUID
*format
, WAVEFORMATEX
**wave
);
1081 uuid(c05c768f
-fae8
-4ec2
-8e07
-338321c12452
),
1082 pointer_default(unique),
1086 interface ISpAudio
: ISpStreamFormat
1088 HRESULT SetState
([in] SPAUDIOSTATE state
, [in] ULONGLONG reserved
);
1089 HRESULT SetFormat
([in] REFGUID guid
, [in] const WAVEFORMATEX
*wave
);
1090 HRESULT GetStatus
([out] SPAUDIOSTATUS
*status
);
1091 HRESULT SetBufferInfo
([in] const SPAUDIOBUFFERINFO
*buffer
);
1092 HRESULT GetBufferInfo
([out] SPAUDIOBUFFERINFO
*buffer
);
1093 HRESULT GetDefaultFormat
([out] GUID
*guid
, [out] WAVEFORMATEX
**wave
);
1094 HANDLE EventHandle
();
1095 HRESULT GetVolumeLevel
([out] ULONG
*level
);
1096 HRESULT SetVolumeLevel
([in] ULONG level
);
1097 HRESULT GetBufferNotifySize
([out] ULONG
*size
);
1098 HRESULT SetBufferNotifySize
([in] ULONG size
);
1103 uuid(5b4fb971
-b115
-4de1
-ad97
-e482e3bf6ee4
),
1104 pointer_default(unique),
1108 interface ISpProperties
: IUnknown
1110 HRESULT SetPropertyNum
([in] const WCHAR
*name
, [in] long value
);
1111 HRESULT GetPropertyNum
([in] const WCHAR
*name
, [out] long *value
);
1112 HRESULT SetPropertyString
([in] const WCHAR
*name
, [in] const WCHAR
*value
);
1113 HRESULT GetPropertyString
([in] const WCHAR
*name
, [out] WCHAR
**value
);
1118 uuid(c2b5f241
-daa0
-4507-9e16
-5a1eaa2b7a5c
),
1119 pointer_default(unique),
1122 interface ISpRecognizer
: ISpProperties
1124 HRESULT SetRecognizer
([in] ISpObjectToken
*recognizer
);
1125 HRESULT GetRecognizer
([out] ISpObjectToken
**recognizer
);
1127 HRESULT SetInput
([in] IUnknown
*input
, [in] BOOL changes
);
1128 HRESULT GetInputObjectToken
([out] ISpObjectToken
**token
);
1130 HRESULT GetInputStream
( [out] ISpStreamFormat
**stream
);
1131 HRESULT CreateRecoContext
([out] ISpRecoContext
**cxt
);
1133 HRESULT GetRecoProfile
([out] ISpObjectToken
**token
);
1134 HRESULT SetRecoProfile
([in] ISpObjectToken
*token
);
1136 HRESULT IsSharedInstance
(void);
1138 HRESULT GetRecoState
([out] SPRECOSTATE
*state
);
1139 HRESULT SetRecoState
([in] SPRECOSTATE state
);
1141 HRESULT GetStatus
([out] SPRECOGNIZERSTATUS
*status
);
1142 HRESULT GetFormat
([in] SPSTREAMFORMATTYPE type
, [out] GUID
*format
, [out] WAVEFORMATEX
**wave
);
1144 [local] HRESULT IsUISupported
([in] const WCHAR
*type
, [in] void *extra
, [in] ULONG count
,
1145 [out] BOOL
*supported
);
1146 [local] HRESULT DisplayUI
([in] HWND hwnd
,[in] const WCHAR
*title
, [in] const WCHAR
*type
,
1147 [in] void *extra
, [in] ULONG cnt
);
1148 HRESULT EmulateRecognition
([in] ISpPhrase
*phrase
);
1153 uuid(12e3cca9
-7518-44c5
-a5e7
-ba5a79cb929e
),
1154 pointer_default(unique),
1158 interface ISpStream
: ISpStreamFormat
1160 HRESULT SetBaseStream
([in] IStream
*stream
, [in] REFGUID format
, [in] const WAVEFORMATEX
*wave
);
1161 HRESULT GetBaseStream
([out] IStream
**stream
);
1162 HRESULT BindToFile
([in] LPCWSTR filename
, [in] SPFILEMODE mode
, [in] const GUID
*format
,
1163 const WAVEFORMATEX
*wave
, [in] ULONGLONG interest
);
1168 helpstring("Speech Object Library"),
1169 uuid(c866ca3a
-32f7
-11d2
-9602-00c04f8ee628
),
1174 importlib
("stdole2.tlb");
1176 #include
"sapiaut.idl"
1179 uuid(a910187f
-0c7a
-45ac
-92cc
-59edafb77b53
),
1180 helpstring("SpObjectTokenCategory Class"),
1181 progid
("SAPI.SpObjectTokenCategory.1"),
1182 vi_progid
("SAPI.SpObjectTokenCategory"),
1185 coclass SpObjectTokenCategory
1187 interface ISpObjectTokenCategory
;
1191 uuid(ef411752
-3736-4cb4
-9c8c
-8ef4ccb58efe
),
1192 helpstring("Object Token"),
1193 progid
("SAPI.SpObjectToken.1"),
1194 vi_progid
("SAPI.SpObjectToken"),
1197 coclass SpObjectToken
1199 interface ISpObjectToken
;
1200 [default] interface ISpDataKey
;
1204 uuid(96749373-3391-11d2
-9ee3
-00c04f797396
),
1205 helpstring("Resource Manager"),
1206 progid
("SAPI.SpResourceManager.1"),
1207 vi_progid
("SAPI.SpResourceManager"),
1212 coclass SpResourceManager
1214 [default] interface ISpResourceManager
;
1218 uuid(3bee4890
-4fe9
-4a37
-8c1e
-5e7e12791c1f
)
1220 coclass SpSharedRecognizer
1222 /*[default] interface ISpeechRecognizer;*/
1223 interface ISpRecognizer
;
1227 uuid(715d9c59
-4442-11d2
-9605-00c04f8ee628
),
1228 helpstring("Speech Stream"),
1229 progid
("SAPI.SpStream.1"),
1230 vi_progid
("SAPI.SpStream"),
1237 interface ISpStream
;
1241 uuid(96749377-3391-11d2
-9ee3
-00c04f797396
)
1246 [default] interface ISpeechVoice
;
1250 uuid(947812b3
-2ae1
-4644-ba86
-9e90ded7ec91
),
1252 coclass SpFileStream
1254 interface ISpStream
;
1255 [default] interface ISpeechFileStream
;