Skip to content

Latest commit

 

History

History
174 lines (115 loc) · 5.62 KB

nf-keyworddetectoroemadapter-ikeyworddetectoroemadapter-getcapabilities.md

File metadata and controls

174 lines (115 loc) · 5.62 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.GetCapabilities
IKeywordDetectorOemAdapter::GetCapabilities (keyworddetectoroemadapter.h)
The GetCapabilities method returns the keywords and languages supported by the object.
audio\ikeyworddetectoroemadapter_getcapabilities.htm
audio
05/08/2018
IKeywordDetectorOemAdapter::GetCapabilities
GetCapabilities, GetCapabilities method [Audio Devices], GetCapabilities method [Audio Devices],IKeywordDetectorOemAdapter interface, IKeywordDetectorOemAdapter interface [Audio Devices],GetCapabilities method, IKeywordDetectorOemAdapter.GetCapabilities, IKeywordDetectorOemAdapter::GetCapabilities, audio.ikeyworddetectoroemadapter_getcapabilities, keyworddetectoroemadapter/IKeywordDetectorOemAdapter::GetCapabilities
keyworddetectoroemadapter.h
Windows
Windows 10
Windows Server 2016
KeywordDetectorOemAdapter.idl
Windows
IKeywordDetectorOemAdapter::GetCapabilities
keyworddetectoroemadapter/IKeywordDetectorOemAdapter::GetCapabilities
APIRef
kbSyntax
COM
KeywordDetectorOemAdapter.h
IKeywordDetectorOemAdapter::GetCapabilities

IKeywordDetectorOemAdapter::GetCapabilities

-description

The GetCapabilities method returns the keywords and languages supported by the object.

-parameters

-param SupportsUserModels [in]

A Boolean value that indicates whether user specific training is supported.

-param KeywordIds [out]

A pointer to an array of keyword IDs supported by the object. The object allocates the array by calling CoTaskMemAlloc. The caller frees the memory by calling CoTaskMemFree.

-param NumKeywords [out]

The number of keyword IDs in the KeywordIds array.

-param LangIds [out]

A pointer to an array of language IDs supported by the object. The object allocates the array by calling CoTaskMemAlloc. The caller frees the memory by calling CoTaskMemFree.

-param NumLanguages [out]

The number of language IDs in the LangIds array.

-param ppMediaType [out]

The audio format required by IKeywordDetectorOemAdapter::VerifyUserKeyword and IKeywordDetectorOemAdapter::ComputeAndAddUserModelData.

The only valid values for the IMFMediaType are the following:

  • Type = Audio
  • Subtype = IEEE_FLOAT
  • Sampling Rate = 16 kHz
  • Bits = 32
Typically, the OEMDLL calls MFCreateMediaType and MFInitMediaTypeFromWaveFormatEx to obtain an IMFMediaType pointer to return to the caller.

-returns

This method can return one of these values.

Return value Description
S_OK
The function exited successfully.
E_POINTER
The pointer for an output parameter is NULL.
E_INVALIDARG
The pointer to the model data is NULL.

-remarks

The information returned from this routine would normally not change for a given version of the OEMDLL or the user independent model data installed along with it.

The OEMDLL must have internal user independent models for the keywords and languages returned from this method.

-see-also

CoTaskMemAlloc

CoTaskMemFree

IKeywordDetectorOemAdapter

IKeywordDetectorOemAdapter::ComputeAndAddUserModelData

IKeywordDetectorOemAdapter::VerifyUserKeyword

IMFMediaType

MFCreateMediaType

MFInitMediaTypeFromWaveFormatEx