ConversationalAgentSignal.DetectorKind Property

Definition

Gets the type of the ActivationSignalDetector associated with the ConversationalAgentSignal.

public:
 property ActivationSignalDetectorKind DetectorKind { ActivationSignalDetectorKind get(); };
ActivationSignalDetectorKind DetectorKind();
public ActivationSignalDetectorKind DetectorKind { get; }
var activationSignalDetectorKind = conversationalAgentSignal.detectorKind;
Public ReadOnly Property DetectorKind As ActivationSignalDetectorKind

Property Value

The type of the ActivationSignalDetector associated with the ConversationalAgentSignal.

Windows requirements

Device family
Windows 11 (introduced in 10.0.22000.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v14.0)

Remarks

This property can be used to determine how to handle a SignalDetected event. Examples include:

  • Signals generated by a HardwareEvent:2 (such as a keyboard button press or bluetooth headset) do not have the keyword audio in their payload.
  • Signals generated by an AudioPattern:0 where the [ConversationalAgentSignal.IsSignalVerificationRequired] (conversationalagentsignal_issignalverificationrequired.md) is set to true need a secondary verification pass by the client to identify the keyword.
  • Signals generated by an AudioPattern:0 where the [ConversationalAgentSignal.IsSignalVerificationRequired] (conversationalagentsignal_issignalverificationrequired.md) is set to false do not need secondary verification, but do include the keyword.

Applies to