Skip to content

Latest commit

 

History

History
146 lines (108 loc) · 4.56 KB

nf-keyworddetectoroemadapter-ikeyworddetectoroemadapter-buildarmingpatterndata.md

File metadata and controls

146 lines (108 loc) · 4.56 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:keyworddetectoroemadapter.IKeywordDetectorOemAdapter.BuildArmingPatternData
IKeywordDetectorOemAdapter::BuildArmingPatternData (keyworddetectoroemadapter.h)
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.
audio\ikeyworddetectoroemadapter_buildarmingpatterndata.htm
audio
05/08/2018
IKeywordDetectorOemAdapter::BuildArmingPatternData
BuildArmingPatternData, BuildArmingPatternData method [Audio Devices], BuildArmingPatternData method [Audio Devices],IKeywordDetectorOemAdapter interface, IKeywordDetectorOemAdapter interface [Audio Devices],BuildArmingPatternData method, IKeywordDetectorOemAdapter.BuildArmingPatternData, IKeywordDetectorOemAdapter::BuildArmingPatternData, audio.ikeyworddetectoroemadapter_buildarmingpatterndata, keyworddetectoroemadapter/IKeywordDetectorOemAdapter::BuildArmingPatternData
keyworddetectoroemadapter.h
Windows
Windows 10
Windows Server 2016
KeywordDetectorOemAdapter.idl
Windows
IKeywordDetectorOemAdapter::BuildArmingPatternData
keyworddetectoroemadapter/IKeywordDetectorOemAdapter::BuildArmingPatternData
APIRef
kbSyntax
COM
KeywordDetectorOemAdapter.h
IKeywordDetectorOemAdapter::BuildArmingPatternData

IKeywordDetectorOemAdapter::BuildArmingPatternData

-description

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.

-parameters

-param UserModelData [in]

A pointer to IStream bound to model data for the KEYWORDSELECTOR values in the KeywordSelectors parameter.

-param KeywordSelectors [in]

An array of KEYWORDSELECTOR structures identifying the desired set of matches for the keyword detector to arm.

-param NumKeywordSelectors [in]

The number of items in the KeywordSelectors array. Only one key word selector is supported and this field must be set to one.

-param ppPatternData [out]

The pattern data for the operating system to pass to the audio driver. The OEMDLL allocates the memory calling CoTaskMemAlloc. The operating system will free the memory by calling CoTaskMemFree.

-returns

This method can return one of these values.

Return value Description
S_OK
The function exited successfully.
E_POINTER
The ModelData pointer is NULL.
E_INVALIDARG
The KeywordId or LangId parameters are invalid.
HRESULT_FROM_WIN32(ERROR_GEN_FAILURE)
The processing was unable to complete.

-remarks

The operating system may call this method at any time. The operating system may also store the returned pattern data to reuse later for the same set of keyword selectors.

-see-also

CoTaskMemAlloc

CoTaskMemFree

IKeywordDetectorOemAdapter

KEYWORDSELECTOR