IKeywordDetectorOemAdapter interface (keyworddetectoroemadapter.h)

IKeywordDetectorOemAdapter is a Component Object Model (COM) interface for interacting with the Voice Activation Driver Interface. The IKeywordDetectorOemAdapter interface is supported in Windows 10 and later versions of Windows.

The OEM supplies a COM object implementation that acts as an intermediary between the operating system and the driver, helping to compute or parse the opaque data that is written and read to the audio driver through KSPROPERTY_SOUNDDETECTOR_PATTERNS and KSPROPERTY_SOUNDDETECTOR_MATCHRESULT.

The class identifier (CLSID) of the COM object is a detector pattern type GUID returned by the KSPROPERTY_SOUNDDETECTOR_SUPPORTEDPATTERNS. The operating system calls CoCreateInstance passing the pattern type GUID to instantiate the appropriate COM object that is compatible with keyword pattern type and calls methods on the object’s IKeywordDetectorOemAdapter interface. The operating supplies a proxy-stub for IKeywordDetectorOemAdapter. The OEM’s implementation may choose any of the COM threading models.

The interface design attempts to keep the object implementation stateless. In other words, the implementation should require no state to be stored between method calls. In fact, internal C++ classes likely do not need any member variables beyond those required to implement a COM object in general.

Inheritance

The IKeywordDetectorOemAdapter interface inherits from the IUnknown interface.

Methods

The IKeywordDetectorOemAdapter interface has these methods.

IKeywordDetectorOemAdapter::BuildArmingPatternData The BuildArmingPatternData method is called by the operating system to build OEM-specific pattern data that includes any keyword and user-specific model data for detection.
IKeywordDetectorOemAdapter::ComputeAndAddUserModelData The ComputeAndAddUserModelData method is used by the training user experience to compute the user-specific information relative to the user-independent keyword.
IKeywordDetectorOemAdapter::GetCapabilities The GetCapabilities method returns the keywords and languages supported by the object.
IKeywordDetectorOemAdapter::ParseDetectionResultData The ParseDetectionResultData method is called by the operating system after handling a keyword detection event and after retrieving the result data from KSPROPERTY_SOUNDDETECTOR_MATCHRESULT.
IKeywordDetectorOemAdapter::VerifyUserKeyword The VerifyUserKeyword method is used by the training user experience to verify that one instance of a spoken utterance, captured during training, matches a predefined keyword within some tolerance.

Requirements

Requirement	Value
Target Platform	Windows
Header	keyworddetectoroemadapter.h