Skip to content

Latest commit

 

History

History
142 lines (114 loc) · 4.5 KB

ksproperty-sounddetector-armed.md

File metadata and controls

142 lines (114 loc) · 4.5 KB
title description keywords topic_type ms.topic api_name api_location api_type ms.date
KSPROPERTY\_SOUNDDETECTOR\_ARMED
The KSPROPERTY\_SOUNDDETECTOR\_ARMED property is the current arming state of the detector.
KSPROPERTY_SOUNDDETECTOR_ARMED Audio Devices
apiref
reference
KSPROPERTY_SOUNDDETECTOR_ARMED
ksmedia.h
HeaderDef
09/26/2019

KSPROPERTY_SOUNDDETECTOR_ARMED

The KSPROPERTY_SOUNDDETECTOR_ARMED property is the current arming state of the detector.

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

Yes

Yes

Filter

KSPROPERTY

BOOL

When called by KSPROPSETID_SoundDetector, the driver resets this to false when:

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

Yes

Yes

Filter

KSSOUNDDETECTORPROPERTY

BOOL

When called with KSPROPSETID_SoundDetector2 the arm state will not be reset when a keyword is detected.

It is reset to false when:

Return Value

The property value is a BOOL indicating the arming state of the detector.

Remarks

The OS sets this true to engage the detector.

Setting this true while no keyword patterns are set (KSPROPERTY_SOUNDDETECTOR_PATTERNS is empty) has no effect.

Note: If this property is true, subsequently setting KSPROPERTY_SOUNDDETECTOR_PATTERNS automatically resets this to false, as mentioned above.

Requirements

Minimum supported client

Windows 10

Minimum supported server

Windows Server 2016

Header

Ksmedia.h

See also

KSPROPERTY_SOUNDDETECTOR_PATTERNS

KSPROPERTY

KSSOUNDDETECTORPROPERTY