KSPROPERTY_SOUNDDETECTOR_PATTERNS

The KSPROPERTY_SOUNDDETECTOR_PATTERNS property is set by the operating system to configure the keywords to be detected.

The OS sets the keyword patterns or may set this to an empty value.

When the OS sets this property, the driver automatically disarms the detector if was previously armed.

If the driver cannot satisfy a “set” request due to insufficient resources, the driver fails the request with STATUS_INSUFFICIENT_RESOURCES.

Usage Summary Table - KSPROPSETID_SoundDetector

This usage table summarizes when KSPROPERTY_SOUNDDETECTOR_ARMED is called with KSPROPSETID_SoundDetector

Get Set Target Property descriptor type Property value type

No

Yes

Filter

KSPROPERTY

KSMULTIPLE_ITEM

Usage Summary Table - KSPROPSETID_SoundDetector2

This usage table summarizes when KSPROPERTY_SOUNDDETECTOR_ARMED is called with KSPROPSETID_SoundDetector2

Get Set Target Property descriptor type Property value type

No

Yes

Filter

KSSOUNDDETECTORPROPERTY

KSMULTIPLE_ITEM

Return Value

The property value is a KSMULTIPLE_ITEM structure followed by a sequence of 64-bit aligned detection patterns. Each pattern starts with a SOUNDDETECTOR_PATTERNHEADER followed by the pattern payload.

Remarks

The driver shall not complete the “set” request until:

The driver may keep the request pending until the above conditions are met. Also, if the device requires measurable initialization time, the driver may keep this request pending until the device is ready and the can process the request.

The OS requires this behavior to avoid race conditions between a detected a keyword and updating keyword patterns (e.g. if a keyword was detected and the KSEVENT_SOUNDDETECTOR generated an instant before the OS updates the keywords).

The OS waits at least 2 seconds for this request to complete.

Requirements

Minimum supported client

Windows 10

Minimum supported server

Windows Server 2016

Header

Ksmedia.h

See also

SOUNDDETECTOR_PATTERNHEADER

SOUNDDETECTOR_PATTERNS

KSPROPERTY_SOUNDDETECTOR_ARMED

KSPROPERTY_SOUNDDETECTOR_MATCHRESULT

KSPROPERTY

KSMULTIPLE_ITEM