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 unsigned short SPPHONEID
;
356 typedef [restricted, hidden] struct SPPHRASEELEMENT
358 ULONG ulAudioTimeOffset
;
359 ULONG ulAudioSizeTime
;
360 ULONG ulAudioStreamOffset
;
361 ULONG ulAudioSizeBytes
;
362 ULONG ulRetainedStreamOffset
;
363 ULONG ulRetainedSizeBytes
;
364 const WCHAR
*pszDisplayText
;
365 const WCHAR
*pszLexicalForm
;
366 const SPPHONEID
*pszPronunciation
;
367 BYTE bDisplayAttributes
;
368 signed char RequiredConfidence
;
369 signed char ActualConfidence
;
371 float SREngineConfidence
;
374 typedef [restricted, hidden] struct SPVOICESTATUS
376 ULONG ulCurrentStream
;
377 ULONG ulLastStreamQueued
;
378 HRESULT hrLastResult
;
379 DWORD dwRunningState
;
380 ULONG ulInputWordPos
;
381 ULONG ulInputWordLen
;
382 ULONG ulInputSentPos
;
383 ULONG ulInputSentLen
;
391 typedef [restricted, hidden] struct SPAUDIOSTATUS
393 long cbFreeBuffSpace
;
394 ULONG cbNonBlockingIO
;
396 ULONGLONG CurSeekPos
;
397 ULONGLONG CurDevicePos
;
402 typedef [restricted, hidden] struct SPRECOGNIZERSTATUS
404 SPAUDIOSTATUS AudioStatus
;
405 ULONGLONG ullRecognitionStreamPos
;
406 ULONG ulStreamNumber
;
410 LANGID aLangID
[SP_MAX_LANGIDS
];
411 ULONGLONG ullRecognitionStreamTime
;
412 } SPRECOGNIZERSTATUS
;
414 typedef [restricted, hidden] struct SPPHRASERULE SPPHRASERULE
;
420 ULONG ulFirstElement
;
421 ULONG ulCountOfElements
;
422 const SPPHRASERULE
* pNextSibling
;
423 const SPPHRASERULE
* pFirstChild
;
424 float SREngineConfidence
;
425 signed char Confidence
;
428 typedef [restricted, hidden] struct SPPHRASEPROPERTY SPPHRASEPROPERTY
;
430 struct SPPHRASEPROPERTY
432 const WCHAR
*pszName
;
434 const WCHAR
*pszValue
;
436 ULONG ulFirstElement
;
437 ULONG ulCountOfElements
;
438 const SPPHRASEPROPERTY
*pNextSibling
;
439 const SPPHRASEPROPERTY
*pFirstChild
;
440 float SREngineConfidence
;
441 signed char Confidence
;
444 typedef [restricted, hidden] struct SPPHRASEREPLACEMENT
446 BYTE bDisplayAttributes
;
447 const WCHAR
*pszReplacementText
;
448 ULONG ulFirstElement
;
449 ULONG ulCountOfElements
;
450 } SPPHRASEREPLACEMENT
;
452 typedef [restricted, hidden] struct SPPHRASE
457 ULONGLONG ullGrammarID
;
458 ULONGLONG ftStartTime
;
459 ULONGLONG ullAudioStreamPosition
;
460 ULONG ulAudioSizeBytes
;
461 ULONG ulRetainedSizeBytes
;
462 ULONG ulAudioSizeTime
;
464 const SPPHRASEPROPERTY
*pProperties
;
465 const SPPHRASEELEMENT
*pElements
;
467 const SPPHRASEREPLACEMENT
*pReplacements
;
469 ULONG ulSREnginePrivateDataSize
;
470 const BYTE *pSREnginePrivateData
;
473 typedef [restricted, hidden] struct SPSERIALIZEDPHRASE
475 ULONG ulSerializedSize
;
476 } SPSERIALIZEDPHRASE
;
478 typedef [restricted, hidden] struct SPRECORESULTTIMES
480 FILETIME ftStreamTime
;
486 cpp_quote
("#if defined(__GNUC__)")
488 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 }")
489 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 }")
490 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 }")
492 cpp_quote
("#elif defined(_MSC_VER)")
494 cpp_quote
("#define SPCAT_AUDIOOUT L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioOutput\"")
495 cpp_quote
("#define SPCAT_AUDIOIN L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioInput\"")
496 cpp_quote
("#define SPCAT_VOICES L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\Voices\"")
500 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};")
501 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};")
502 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};")
506 interface IEnumSpObjectTokens
;
507 interface ISpEventSource
;
508 interface ISpRecoContext
;
509 interface ISpRecognizer
;
510 interface ISpStreamFormat
;
514 uuid(14056581-e16c
-11d2
-bb90
-00c04f8ee6c0
),
515 helpstring("ISpDataKey"),
516 pointer_default(unique),
520 interface ISpDataKey
: IUnknown
522 HRESULT SetData
([in] LPCWSTR pszValueName
,
524 [in] const BYTE *pData
);
525 HRESULT GetData
([in] LPCWSTR pszValueName
,
528 HRESULT SetStringValue
([in] LPCWSTR pszValueName
,
529 [in] LPCWSTR pszValue
);
530 HRESULT GetStringValue
([in] LPCWSTR pszValueName
,
531 [out] LPWSTR
*ppszValue
);
532 HRESULT SetDWORD
([in] LPCWSTR pszValueName
,
534 HRESULT GetDWORD
([in] LPCWSTR pszValueName
,
535 [out] DWORD
*pdwValue
);
536 HRESULT OpenKey
([in] LPCWSTR pszSubKeyName
,
537 [out] ISpDataKey
**ppSubKey
);
538 HRESULT CreateKey
([in] LPCWSTR pszSubKey
,
539 [out] ISpDataKey
**ppSubKey
);
540 HRESULT DeleteKey
([in] LPCWSTR pszSubKey
);
541 HRESULT DeleteValue
([in] LPCWSTR pszValueName
);
542 HRESULT EnumKeys
([in] ULONG Index
,
543 [out] LPWSTR
*ppszSubKeyName
);
544 HRESULT EnumValues
([in] ULONG Index
,
545 [out] LPWSTR
*ppszValueName
);
549 uuid(92a66e2b
-c830
-4149-83df
-6fc2ba1e7a5b
),
550 helpstring("ISpRegDataKey"),
551 pointer_default(unique),
554 interface ISpRegDataKey
: ISpDataKey
556 [local] HRESULT SetKey
([in] HKEY hkey
, [in] BOOL fReadOnly
);
561 uuid(2d3d3845
-39af
-4850-bbf9
-40b49780011d
),
562 helpstring("ISpObjectTokenCategory"),
563 pointer_default(unique),
567 interface ISpObjectTokenCategory
: ISpDataKey
569 HRESULT SetId
([in] LPCWSTR pszCategoryId
,
570 [in] BOOL fCreateIfNotExist
);
571 HRESULT GetId
([out] LPWSTR
*ppszCoMemCategoryId
);
572 HRESULT GetDataKey
([in] SPDATAKEYLOCATION spdkl
,
573 [out] ISpDataKey
**ppDataKey
);
574 HRESULT EnumTokens
([in, string] LPCWSTR pszReqAttribs
,
575 [in, string] LPCWSTR pszOptAttribs
,
576 [out] IEnumSpObjectTokens
**ppEnum
);
577 HRESULT SetDefaultTokenId
([in] LPCWSTR pszTokenId
);
578 HRESULT GetDefaultTokenId
([out] LPWSTR
*ppszCoMemTokenId
);
583 uuid(14056589-e16c
-11d2
-bb90
-00c04f8ee6c0
),
584 helpstring("ISpObjectToken"),
585 pointer_default(unique),
589 interface ISpObjectToken
: ISpDataKey
591 HRESULT SetId
(/*[in]*/ LPCWSTR pszCategoryId
,
592 [in] LPCWSTR pszTokenId
,
593 [in] BOOL fCreateIfNotExist
);
594 HRESULT GetId
([out] LPWSTR
*ppszCoMemTokenId
);
595 HRESULT GetCategory
([out] ISpObjectTokenCategory
**ppTokenCategory
);
596 HRESULT CreateInstance
([in] IUnknown
*pUnkOuter
,
597 [in] DWORD dwClsContext
,
599 [out, iid_is(riid
)] void **ppvObject
);
600 HRESULT GetStorageFileName
([in] REFCLSID clsidCaller
,
601 [in] LPCWSTR pszValueName
,
602 [in, string] LPCWSTR pszFileNameSpecifier
,
604 [out] LPWSTR
*ppszFilePath
);
605 HRESULT RemoveStorageFileName
([in] REFCLSID clsidCaller
,
606 [in] LPCWSTR pszKeyName
,
607 [in] BOOL fDeleteFile
);
608 HRESULT Remove
(/*[in]*/ const CLSID
*pclsidCaller
);
609 [local] HRESULT IsUISupported
([in] LPCWSTR pszTypeOfUI
,
610 [in] void *pvExtraData
,
611 [in] ULONG cbExtraData
,
612 [in] IUnknown
*punkObject
,
613 [out] BOOL
*pfSupported
);
614 [local] HRESULT DisplayUI
([in] HWND hwndParent
,
615 [in] LPCWSTR pszTitle
,
616 [in] LPCWSTR pszTypeOfUI
,
617 [in] void *pvExtraData
,
618 [in] ULONG cbExtraData
,
619 [in] IUnknown
*punkObject
);
620 HRESULT MatchesAttributes
([in] LPCWSTR pszAttributes
,
621 [out] BOOL
*pfMatches
);
626 uuid(06b64f9e
-7fda
-11d2
-b4f2
-00c04f797396
),
627 helpstring("IEnumSpObjectTokens"),
628 pointer_default(unique),
632 interface IEnumSpObjectTokens
: IUnknown
634 HRESULT Next
([in] ULONG celt
,
635 [out, size_is(celt
), length_is(*pceltFetched
)] ISpObjectToken
**pelt
,
636 [out] ULONG
*pceltFetched
);
637 HRESULT Skip
([in] ULONG celt
);
639 HRESULT Clone
([out] IEnumSpObjectTokens
**ppEnum
);
640 HRESULT Item
([in] ULONG Index
,
641 [out] ISpObjectToken
**ppToken
);
642 HRESULT GetCount
([out] ULONG
*pCount
);
647 uuid(1a5c0354
-b621
-4b5a
-8791-d306ed379e53
),
649 pointer_default(unique),
652 interface ISpPhrase
: IUnknown
654 HRESULT GetPhrase
([out] SPPHRASE
**phrase
);
655 HRESULT GetSerializedPhrase
([out] SPSERIALIZEDPHRASE
**phrase
);
656 HRESULT GetText
([in] ULONG start
, [in] ULONG count
, [in] BOOL replacements
,
657 [out] WCHAR
**text
, [out] BYTE *attributes
);
658 HRESULT Discard
([in] DWORD types
);
663 uuid(8fcebc98
-4e49
-4067-9c6c
-d86a0e092e3d
),
665 pointer_default(unique),
668 interface ISpPhraseAlt
: ISpPhrase
670 HRESULT GetAltInfo
(ISpPhrase
**parent
, ULONG
*start
, ULONG
*count
,
677 uuid(20b053be
-e235
-43cd
-9a2a
-8d17a48b7842
),
678 pointer_default(unique),
682 interface ISpRecoResult
: ISpPhrase
684 HRESULT GetResultTimes
([out] SPRECORESULTTIMES
*times
);
686 HRESULT GetAlternates
(
690 [out] ISpPhraseAlt
**phrases
,
691 [out] ULONG
*returned
);
696 [out] ISpStreamFormat
**stream
);
701 [out] ULONG
*number
);
703 HRESULT Serialize
([out] SPSERIALIZEDRESULT
**result
);
705 HRESULT ScaleAudio
([in] const GUID
*format
, [in] const WAVEFORMATEX
*wave
);
707 HRESULT GetRecoContext
([out] ISpRecoContext
*context
);
712 uuid(8137828f
-591a
-4a42
-be58
-49ea7ebaac68
),
713 helpstring("ISpGrammarBuilder Interface"),
714 pointer_default(unique),
718 interface ISpGrammarBuilder
: IUnknown
720 HRESULT ResetGrammar
([in] LANGID language
);
722 HRESULT GetRule
([in] const WCHAR
*rule
,
724 [in] DWORD attributes
,
725 [in] BOOL should_create
,
726 [out] SPSTATEHANDLE
*state
);
727 HRESULT ClearRule
(SPSTATEHANDLE state
);
729 HRESULT CreateNewState
(
730 [in] SPSTATEHANDLE instate
,
731 [out] SPSTATEHANDLE
*outstate
);
733 HRESULT AddWordTransition
(
734 [in] SPSTATEHANDLE from_state
,
735 [in] SPSTATEHANDLE to_state
,
736 [in] const WCHAR
*value
,
737 [in] const WCHAR
*separators
,
738 [in] SPGRAMMARWORDTYPE type
,
740 [in] const SPPROPERTYINFO
*info
);
742 HRESULT AddRuleTransition
(
743 [in] SPSTATEHANDLE from_state
,
744 [in] SPSTATEHANDLE to_state
,
745 [in] SPSTATEHANDLE rule
,
747 [in] const SPPROPERTYINFO
*info
);
749 HRESULT AddResource
([in] SPSTATEHANDLE state
,
750 [in] const WCHAR
*name
,
751 [in] const WCHAR
*value
);
753 HRESULT Commit
([in] DWORD reserved
);
758 uuid(2177db29
-7f45
-47d0
-8554-067e91c80502
),
759 pointer_default(unique),
763 interface ISpRecoGrammar
: ISpGrammarBuilder
765 HRESULT GetGrammarId
([out] ULONGLONG
*grammar
);
766 HRESULT GetRecoContext
([out] ISpRecoContext
**context
);
768 HRESULT LoadCmdFromFile
([in, string] const WCHAR
* pszFileName
, [in] SPLOADOPTIONS options
);
769 HRESULT LoadCmdFromObject
([in] REFCLSID rcid
, [in, string] const WCHAR
* pszGrammarName
, [in] SPLOADOPTIONS options
);
770 HRESULT LoadCmdFromResource
([in] HMODULE hmod
,
771 [in, string] const WCHAR
*name
,
772 [in, string] const WCHAR
*type
,
774 [in] SPLOADOPTIONS options
);
775 HRESULT LoadCmdFromMemory
([in] const SPBINARYGRAMMAR
*grammar
, [in] SPLOADOPTIONS options
);
776 HRESULT LoadCmdFromProprietaryGrammar
(
778 [in, string] const WCHAR
*param
,
779 [in] const void *data
,
781 [in] SPLOADOPTIONS options
);
782 HRESULT SetRuleState
([in, string] const WCHAR
*name
, [in] void *reserved
,
783 [in] SPRULESTATE state
);
784 HRESULT SetRuleIdState
([in] ULONG rule
, [in] SPRULESTATE state
);
786 HRESULT LoadDictation
([in, string] const WCHAR
*name
, [in] SPLOADOPTIONS options
);
787 HRESULT UnloadDictation
();
788 HRESULT SetDictationState
([in] SPRULESTATE state
);
790 HRESULT SetWordSequenceData
([in] const WCHAR
*text
, [in] ULONG count
, [in] const SPTEXTSELECTIONINFO
*info
);
791 HRESULT SetTextSelection
([in] const SPTEXTSELECTIONINFO
*info
);
793 HRESULT IsPronounceable
([in, string] const WCHAR
*word
, [out] SPWORDPRONOUNCEABLE
*pronounceable
);
795 HRESULT SetGrammarState
([in] SPGRAMMARSTATE state
);
797 HRESULT SaveCmd
([in] IStream
*stream
, [out, optional] WCHAR
**error
);
799 HRESULT GetGrammarState
([out] SPGRAMMARSTATE
*state
);
804 uuid(259684dc
-37c3
-11d2
-9603-00c04f8ee628
),
805 pointer_default(unique),
808 interface ISpNotifySink
: IUnknown
810 HRESULT Notify
(void);
815 uuid(6c44df74
-72b9
-4992-a1ec
-ef996e0422d4
),
816 pointer_default(unique),
819 interface ISpVoice
: ISpEventSource
821 HRESULT SetOutput
([in] IUnknown
*unk
, [in] BOOL changes
);
822 HRESULT GetOutputObjectToken
([out] ISpObjectToken
**token
);
823 HRESULT GetOutputStream
([out] ISpStreamFormat
**stream
);
826 HRESULT Resume
(void);
828 HRESULT SetVoice
([in] ISpObjectToken
*token
);
829 HRESULT GetVoice
([out] ISpObjectToken
**token
);
831 HRESULT Speak
([in, string] const WCHAR
*pwcs
,
833 [out] ULONG
*number
);
834 HRESULT SpeakStream
([in] IStream
*stream
,
836 [out] ULONG
*number
);
839 [out] SPVOICESTATUS
*status
,
840 [out, string] WCHAR
**bookmark
);
842 HRESULT Skip
([in,string] WCHAR
* type
, [in] long items
, [out] ULONG
*skipped
);
844 HRESULT SetPriority
([in] SPVPRIORITY priority
);
845 HRESULT GetPriority
([out] SPVPRIORITY
* priority
);
847 HRESULT SetAlertBoundary
([in] SPEVENTENUM boundary
);
848 HRESULT GetAlertBoundary
([out] SPEVENTENUM
* boundary
);
850 HRESULT SetRate
([in] long adjust
);
851 HRESULT GetRate
([out] long *adjust
);
853 HRESULT SetVolume
([in] USHORT volume
);
854 HRESULT GetVolume
([out] USHORT
*volume
);
856 HRESULT WaitUntilDone
([in] ULONG timeout
);
858 HRESULT SetSyncSpeakTimeout
([in] ULONG timeout
);
859 HRESULT GetSyncSpeakTimeout
([out] ULONG
*timeout
);
861 [local] HANDLE SpeakCompleteEvent
();
863 [local] HRESULT IsUISupported
(
864 [in] const WCHAR
*type
,
867 [out] BOOL
*supported
);
868 [local] HRESULT DisplayUI
(
870 [in] const WCHAR
*title
,
871 [in] const WCHAR
*type
,
878 uuid(5eff4aef
-8487-11d2
-961c
-00c04f8ee628
),
879 pointer_default(unique),
882 interface ISpNotifySource
: IUnknown
884 HRESULT SetNotifySink
([in] ISpNotifySink
*sink
);
885 [local] HRESULT SetNotifyWindowMessage
(
890 [local] HRESULT SetNotifyCallbackFunction
(
891 [in] SPNOTIFYCALLBACK
*callback,
894 [local] HRESULT SetNotifyCallbackInterface
(
895 [in] ISpNotifyCallback
*callback,
898 [local] HRESULT SetNotifyWin32Event
(void);
899 [local] HRESULT WaitForNotifyEvent
([in] DWORD milliseconds
);
900 [local] HANDLE GetNotifyEventHandle
();
905 uuid(be7a9cce
-5f9e
-11d2
-960f
-00c04f8ee628
),
906 pointer_default(unique),
910 interface ISpEventSource
: ISpNotifySource
912 HRESULT SetInterest
([in] ULONGLONG event
, [in] ULONGLONG queued
);
913 HRESULT GetEvents
([in] ULONG count
,
914 [out, size_is(count
)] SPEVENT
*array
,
915 [out] ULONG
*fetched
);
916 HRESULT GetInfo
([out] SPEVENTSOURCEINFO
*info
);
921 uuid(f740a62f
-7c15
-489e-8234-940a33d9272d
),
922 pointer_default(unique),
926 interface ISpRecoContext
: ISpEventSource
928 HRESULT GetRecognizer
([out] ISpRecognizer
**recognizer
);
930 HRESULT CreateGrammar
([in] ULONGLONG grammar
, [out] ISpRecoGrammar
**spgrammar
);
932 HRESULT GetStatus
([out] SPRECOCONTEXTSTATUS
*status
);
934 HRESULT GetMaxAlternates
([in] ULONG
*alternates
);
935 HRESULT SetMaxAlternates
([in] ULONG alternates
);
937 HRESULT SetAudioOptions
([in] SPAUDIOOPTIONS options
, [in] const GUID
*format
, [in] const WAVEFORMATEX
*wave
);
938 HRESULT GetAudioOptions
([in] SPAUDIOOPTIONS
*options
, [out] GUID
*format
, [out] WAVEFORMATEX
**wave
);
940 HRESULT DeserializeResult
([in] const SPSERIALIZEDRESULT
*serialized
, [out] ISpRecoResult
**result
);
942 HRESULT Bookmark
([in] SPBOOKMARKOPTIONS options
, [in] ULONGLONG position
, [in] LPARAM event
);
944 HRESULT SetAdaptationData
([in, string] const WCHAR
*data
, [in] const ULONG count
);
946 HRESULT Pause
(DWORD reserved
);
947 HRESULT Resume
(DWORD reserved
);
949 HRESULT SetVoice
([in] ISpVoice
*voice
, [in] BOOL changes
);
950 HRESULT GetVoice
([out] ISpVoice
**voice
);
951 HRESULT SetVoicePurgeEvent
([in] ULONGLONG interest
);
952 HRESULT GetVoicePurgeEvent
([out] ULONGLONG
*interest
);
954 HRESULT SetContextState
([in] SPCONTEXTSTATE state
);
955 HRESULT GetContextState
([in] SPCONTEXTSTATE
*state
);
960 uuid(bed530be
-2606-4f4d
-a1c0
-54c5cda5566f
),
961 pointer_default(unique),
964 interface ISpStreamFormat
: IStream
966 HRESULT GetFormat
(GUID
*format
, WAVEFORMATEX
**wave
);
971 uuid(5b4fb971
-b115
-4de1
-ad97
-e482e3bf6ee4
),
972 pointer_default(unique),
976 interface ISpProperties
: IUnknown
978 HRESULT SetPropertyNum
([in] const WCHAR
*name
, [in] long value
);
979 HRESULT GetPropertyNum
([in] const WCHAR
*name
, [out] long *value
);
980 HRESULT SetPropertyString
([in] const WCHAR
*name
, [in] const WCHAR
*value
);
981 HRESULT GetPropertyString
([in] const WCHAR
*name
, [out] WCHAR
**value
);
986 uuid(c2b5f241
-daa0
-4507-9e16
-5a1eaa2b7a5c
),
987 pointer_default(unique),
990 interface ISpRecognizer
: ISpProperties
992 HRESULT SetRecognizer
([in] ISpObjectToken
*recognizer
);
993 HRESULT GetRecognizer
([out] ISpObjectToken
**recognizer
);
995 HRESULT SetInput
([in] IUnknown
*input
, [in] BOOL changes
);
996 HRESULT GetInputObjectToken
([out] ISpObjectToken
**token
);
998 HRESULT GetInputStream
( [out] ISpStreamFormat
**stream
);
999 HRESULT CreateRecoContext
([out] ISpRecoContext
**cxt
);
1001 HRESULT GetRecoProfile
([out] ISpObjectToken
**token
);
1002 HRESULT SetRecoProfile
([in] ISpObjectToken
*token
);
1004 HRESULT IsSharedInstance
(void);
1006 HRESULT GetRecoState
([out] SPRECOSTATE
*state
);
1007 HRESULT SetRecoState
([in] SPRECOSTATE state
);
1009 HRESULT GetStatus
([out] SPRECOGNIZERSTATUS
*status
);
1010 HRESULT GetFormat
([in] SPSTREAMFORMATTYPE type
, [out] GUID
*format
, [out] WAVEFORMATEX
**wave
);
1012 [local] HRESULT IsUISupported
([in] const WCHAR
*type
, [in] void *extra
, [in] ULONG count
,
1013 [out] BOOL
*supported
);
1014 [local] HRESULT DisplayUI
([in] HWND hwnd
,[in] const WCHAR
*title
, [in] const WCHAR
*type
,
1015 [in] void *extra
, [in] ULONG cnt
);
1016 HRESULT EmulateRecognition
([in] ISpPhrase
*phrase
);
1020 helpstring("Speech Object Library"),
1021 uuid(c866ca3a
-32f7
-11d2
-9602-00c04f8ee628
),
1026 importlib
("stdole2.tlb");
1028 #include
"sapiaut.idl"
1031 uuid(a910187f
-0c7a
-45ac
-92cc
-59edafb77b53
),
1032 helpstring("SpObjectTokenCategory Class"),
1033 progid
("SAPI.SpObjectTokenCategory.1"),
1034 vi_progid
("SAPI.SpObjectTokenCategory"),
1037 coclass SpObjectTokenCategory
1039 interface ISpObjectTokenCategory
;
1043 uuid(3bee4890
-4fe9
-4a37
-8c1e
-5e7e12791c1f
)
1045 coclass SpSharedRecognizer
1047 /*[default] interface ISpeechRecognizer;*/
1048 interface ISpRecognizer
;