ActivationSignalDetector Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents hardware and software components that can generate activation signals based on input from a user's environment, such as spoken keyword(s), sound detection, or button press.
public ref class ActivationSignalDetector sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 655360)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ActivationSignalDetector final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 655360)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ActivationSignalDetectorPublic NotInheritable Class ActivationSignalDetector- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10, version 2004 (introduced in 10.0.19041.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v10.0)
|
Properties
| CanCreateConfigurations |
Gets whether the ActivationSignalDetector can add or remove items from its collection of ActivationSignalDetectionConfiguration objects. |
| DetectorId |
Gets the unique identifier of the ActivationSignalDetector. |
| Kind |
Gets the supported ActivationSignalDetector types. |
| ProviderId |
Gets an identifier unique to the provider of this detector, such as the manufacturer of a hardware-based keyword spotter. |
| SupportedModelDataTypes |
Gets the model configuration data types supported by the signal detector. |
| SupportedPowerStates |
Gets the power modes supported by an ActivationSignalDetector. |
| SupportedTrainingDataFormats |
Gets the supported formats for training an ActivationSignalDetector. |
Methods
| CreateConfiguration(String, String, String) |
Creates an ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair and adds it to the collection of supported configurations for the detector. Important To avoid possible concurrency issues, we recommend using CreateConfigurationAsync instead. |
| CreateConfigurationAsync(String, String, String) |
Asynchronously creates an ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair and adds it to the collection of supported configurations for the detector. |
| CreateConfigurationWithResult(String, String, String) |
Creates an ActivationSignalDetectionConfigurationCreationResult object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair, adds it to the collection of supported configurations for the detector, along with an indicator of success. Important To avoid possible concurrency issues, we recommend using CreateConfigurationWithResultAsync(System.String,System.String,System.String) instead. |
| CreateConfigurationWithResultAsync(String, String, String) |
Aynchronously creates an ActivationSignalDetectionConfigurationCreationResult object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair, adds it to the collection of supported configurations for the detector, along with an indicator of success. |
| GetAvailableModelIdsForSignalId(String) |
Gets the collection of model identifiers available to this detector for the specified signal identifier. For example, all supported locales for language-specific versions of the "Hey Cortana" keyword. |
| GetAvailableModelIdsForSignalIdAsync(String) |
Asynchronously gets the collection of model identifiers available to this detector for the specified signal identifier. For example, all supported locales for language-specific versions of the "Hey Cortana" keyword. |
| GetConfiguration(String, String) |
Gets the ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair. Important To avoid possible concurrency issues, we recommend using GetConfigurationAsync instead. |
| GetConfigurationAsync(String, String) |
Asynchronously gets the ActivationSignalDetectionConfiguration object associated with the specified ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair. |
| GetConfigurations() |
Gets the collection of ActivationSignalDetectionConfiguration objects associated with the ActivationSignalDetector. Important To avoid possible concurrency issues, we recommend using GetConfigurationsAsync instead. |
| GetConfigurationsAsync() |
Asynchronously gets the collection of ActivationSignalDetectionConfiguration objects associated with the ActivationSignalDetector. |
| GetSupportedModelIdsForSignalId(String) |
Asynchronously gets the collection of model identifiers supported by this detector for the specified signal identifier. For example, all supported locales for language-specific versions of the "Hey Cortana" keyword. Important To avoid possible concurrency issues, we recommend using GetSupportedModelIdsForSignalIdAsync instead. |
| GetSupportedModelIdsForSignalIdAsync(String) |
Asynchronously gets the collection of model identifiers supported by this detector for the specified signal identifier. For example, all supported locales for language-specific versions of the "Hey Cortana" keyword. |
| RemoveConfiguration(String, String) |
Removes the ActivationSignalDetectionConfiguration identified by the ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair. Important To avoid possible concurrency issues, we recommend using RemoveConfigurationAsync instead. |
| RemoveConfigurationAsync(String, String) |
Asynchronously removes the ActivationSignalDetectionConfiguration identified by the ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair. |
| RemoveConfigurationWithResult(String, String) |
Removes the ActivationSignalDetectionConfiguration identified by the ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair, and returns an indicator of success. Important To avoid possible concurrency issues, we recommend using RemoveConfigurationWithResultAsync(System.String,System.String) instead. |
| RemoveConfigurationWithResultAsync(String, String) |
Asynchronously removes the ActivationSignalDetectionConfiguration identified by the ActivationSignalDetectionConfiguration.SignalId and ActivationSignalDetectionConfiguration.ModelId pair, and returns an indicator of success. |