ActivationSignalDetectionConfiguration Class

Definition

Namespace:

Windows.ApplicationModel.ConversationalAgent

Provides the configuration details for a single signal supported by an activation signal detector. For example, the keyword "Hey Cortana" in US English.

public ref class ActivationSignalDetectionConfiguration sealed : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 655360)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ActivationSignalDetectionConfiguration final : IClosable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 655360)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ActivationSignalDetectionConfiguration : System.IDisposable

Public NotInheritable Class ActivationSignalDetectionConfiguration
Implements IDisposable

Inheritance

Object Platform::Object IInspectable ActivationSignalDetectionConfiguration

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IClosable IDisposable

Windows requirements

Device family	Windows 10, version 2004 (introduced in 10.0.19041.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v10.0)

Properties

AvailabilityInfo	Gets the current usage restrictions unique to this configuration.
DisplayName	Gets the name of the signal in a localizable, human-readable form.
IsActive	Gets whether an ActivationSignalDetectionConfiguration object is processing configuration settings. Gets whether this configuration meets all criteria for the associated ActivationSignalDetector to process input corresponding to the signal.
ModelId	Gets the identifier, typically locale-specific, for the model data associated with this configuration.
SignalId	Gets the locale-independent identifier for this configuration.
TrainingDataFormat	Gets the supported data format used for signal detection training with this configuration (if available).
TrainingStepCompletionMaxAllowedTime	Gets the maximum time allowed to complete a training step for this configuration (if available).
TrainingStepsCompleted	Gets the number of steps completed in the training process of this configuration (if available).
TrainingStepsRemaining	Gets the number of steps remaining in the training process of this configuration (if available).

Methods

ApplyTrainingData(ActivationSignalDetectionTrainingDataFormat, IInputStream)	Provides input data in the specified format and attempts to complete a training step (if a training process is available for the signal detector of this configuration). Important To avoid possible concurrency issues, we recommend using ApplyTrainingDataAsync instead.
ApplyTrainingDataAsync(ActivationSignalDetectionTrainingDataFormat, IInputStream)	Asynchronously provides input data in the specified format and attempts to complete a training step (if a training process is available for the signal detector of this configuration).
ClearModelData()	Deletes all model data for the digital assistant. Important To avoid possible concurrency issues, we recommend using ClearModelDataAsync instead.
ClearModelDataAsync()	Asynchronously deletes all model data for the digital assistant.
ClearTrainingData()	Deletes all voice training data from the ActivationSignalDetector for the digital assistant. Important To avoid possible concurrency issues, we recommend using ClearTrainingDataAsync instead.
ClearTrainingDataAsync()	Asynchronously deletes all voice training data from the ActivationSignalDetector for the digital assistant.
Close()	Closes the ActivationSignalDetectionConfiguration object and releases system resources.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetModelData()	Gets the model configuration data (specific to a signal detector). Important To avoid possible concurrency issues, we recommend using GetModelDataAsync instead.
GetModelDataAsync()	Asynchronously gets the model configuration data (specific to a signal detector).
GetModelDataType()	Gets the model configuration data type (specific to a signal detector). Important To avoid possible concurrency issues, we recommend using GetModelDataTypeAsync instead.
GetModelDataTypeAsync()	Asynchronously gets the model configuration data type (specific to a signal detector).
SetEnabled(Boolean)	Enables or disables the configuration in an application-level manner, independent of system-level settings. The configuration must be both allowed and enabled for its associated ActivationSignalDetector. Important To avoid possible concurrency issues, we recommend using SetEnabledAsync instead.
SetEnabledAsync(Boolean)	Asynchronously enables or disables the configuration in an application-level manner, independent of system-level settings. The configuration must be both allowed and enabled for its associated ActivationSignalDetector.
SetEnabledWithResult(Boolean)	Enables or disables the configuration in an application-level manner, independent of system-level settings, and returns an indicator of success. The configuration must be both allowed and enabled for its associated ActivationSignalDetector. Important To avoid possible concurrency issues, we recommend using SetEnabledAsync instead.
SetEnabledWithResultAsync(Boolean)	Asynchronously enables or disables the configuration in an application-level manner, independent of system-level settings, and returns an indicator of success. The configuration must be both allowed and enabled for its associated ActivationSignalDetector. Important To avoid possible concurrency issues, we recommend using SetEnabledAsync instead.
SetModelData(String, IInputStream)	Sets the model configuration data (specific to a signal detector). Important To avoid possible concurrency issues, we recommend using SetModelDataAsync instead.
SetModelDataAsync(String, IInputStream)	Asynchronously sets the model configuration data (specific to a signal detector).
SetModelDataWithResult(String, IInputStream)	Sets the model configuration data (specific to a signal detector), and returns an indicator of success.
SetModelDataWithResultAsync(String, IInputStream)	Asynchronously sets the model configuration data (specific to a signal detector), and returns an indicator of success.

Events

AvailabilityChanged

Occurs when the availability state of the ActivationSignalDetector changes.

See also

• ActivationSignalDetector
• ConversationalAgentSignal
• Signal