FaceDetectionEffectDefinition
FaceDetectionEffectDefinition
FaceDetectionEffectDefinition
FaceDetectionEffectDefinition
Class
Definition
Represents the definition of a face detection video effect.
public : sealed class FaceDetectionEffectDefinition : IFaceDetectionEffectDefinition, IVideoEffectDefinitionpublic sealed class FaceDetectionEffectDefinition : IFaceDetectionEffectDefinition, IVideoEffectDefinitionPublic NotInheritable Class FaceDetectionEffectDefinition Implements IFaceDetectionEffectDefinition, IVideoEffectDefinition// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
Get an instance of the FaceDetectionEffect class by passing a FaceDetectionEffectDefinition object into AddVideoEffectAsync.
Constructors
FaceDetectionEffectDefinition() FaceDetectionEffectDefinition() FaceDetectionEffectDefinition() FaceDetectionEffectDefinition()
Initializes a new instance of the FaceDetectionEffectDefinition class.
public : FaceDetectionEffectDefinition()public FaceDetectionEffectDefinition()Public Sub New()// You can use this method in JavaScript.
Properties
ActivatableClassId ActivatableClassId ActivatableClassId ActivatableClassId
Gets a string containing the activatable class ID of the face detection effect definition.
public : PlatForm::String ActivatableClassId { get; }public string ActivatableClassId { get; }Public ReadOnly Property ActivatableClassId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The activatable class ID of the face detection effect definition.
DetectionMode DetectionMode DetectionMode DetectionMode
Gets or sets a value that prioritizes the speed of face detection and the quality of detection results.
public : FaceDetectionMode DetectionMode { get; set; }public FaceDetectionMode DetectionMode { get; set; }Public ReadWrite Property DetectionMode As FaceDetectionMode// You can use this property in JavaScript.
A value that prioritizes the speed of face detection and the quality of detection results.
Properties Properties Properties Properties
Gets the set of properties for configuring the FaceDetectionEffectDefinition object.
public : IPropertySet Properties { get; }public IPropertySet Properties { get; }Public ReadOnly Property Properties As IPropertySet// You can use this property in JavaScript.
The set of properties for configuring the FaceDetectionEffectDefinition object.
SynchronousDetectionEnabled SynchronousDetectionEnabled SynchronousDetectionEnabled SynchronousDetectionEnabled
Gets or sets a value indicating whether synchronous face detection is enabled.
public : PlatForm::Boolean SynchronousDetectionEnabled { get; set; }public bool SynchronousDetectionEnabled { get; set; }Public ReadWrite Property SynchronousDetectionEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if synchronous face detection is enabled; otherwise, false.
Remarks
When synchronous detection is enabled, the system will delay the return of a video frame until the face detection operation for the frame is complete. When the frames do arrive, the timestamp of the FaceDetectionEffectFrame will match the timestamp of the associated VideoFrame. When synchronous detection is disabled, the timestamp of the FaceDetectionEffectFrame will typically be slightly later than the associated@Windows.Media.VideoFrame?text=VideoFrame.