FaceDetectionEffectFrame FaceDetectionEffectFrame FaceDetectionEffectFrame FaceDetectionEffectFrame Class

Definition

Represents a video frame that includes a list of faces detected by the FaceDetectionEffect.

public : sealed class FaceDetectionEffectFrame : IClosable, IFaceDetectionEffectFrame, IMediaFramepublic sealed class FaceDetectionEffectFrame : IDisposable, IFaceDetectionEffectFrame, IMediaFramePublic NotInheritable Class FaceDetectionEffectFrame Implements IDisposable, IFaceDetectionEffectFrame, IMediaFrame// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Get an instance of this class by accessing the FaceDetectedEventArgs.ResultFrame.

Properties

DetectedFaces DetectedFaces DetectedFaces DetectedFaces

Gets the list of objects representing the faces detected in the frame.

public : IVectorView<DetectedFace> DetectedFaces { get; }public IReadOnlyList<DetectedFace> DetectedFaces { get; }Public ReadOnly Property DetectedFaces As IReadOnlyList<DetectedFace>// You can use this property in JavaScript.
Value
IVectorView<DetectedFace> IReadOnlyList<DetectedFace> IReadOnlyList<DetectedFace> IReadOnlyList<DetectedFace>

The list of objects representing the faces detected in the frame.

Duration Duration Duration Duration

Gets or sets the duration of the face detection effect frame.

public : IReference<TimeSpan> Duration { get; set; }public Nullable<TimeSpan> Duration { get; set; }Public ReadWrite Property Duration As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

The duration of the face detection effect frame.

ExtendedProperties ExtendedProperties ExtendedProperties ExtendedProperties

Gets the extended property set which enables getting and setting properties on the media frame.

public : IPropertySet ExtendedProperties { get; }public IPropertySet ExtendedProperties { get; }Public ReadOnly Property ExtendedProperties As IPropertySet// You can use this property in JavaScript.
Value
IPropertySet IPropertySet IPropertySet IPropertySet

The extended properties map.

IsDiscontinuous IsDiscontinuous IsDiscontinuous IsDiscontinuous

Gets or sets a value that indicates whether a video frame is the first frame after a gap in the stream.

public : PlatForm::Boolean IsDiscontinuous { get; set; }public bool IsDiscontinuous { get; set; }Public ReadWrite Property IsDiscontinuous As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the video frame is the first frame after a gap in the stream; otherwise, false.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets a value indicating whether the frame is read-only.

public : PlatForm::Boolean IsReadOnly { get; }public bool IsReadOnly { get; }Public ReadOnly Property IsReadOnly As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the frame is read-only; otherwise, false.

RelativeTime RelativeTime RelativeTime RelativeTime

Gets or sets the relative time of the frame within the video stream.

public : IReference<TimeSpan> RelativeTime { get; set; }public Nullable<TimeSpan> RelativeTime { get; set; }Public ReadWrite Property RelativeTime As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

The relative time of the frame within the video stream.

Remarks

Use SystemRelativeTime to get a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

SystemRelativeTime SystemRelativeTime SystemRelativeTime SystemRelativeTime

Gets or sets a timestamp that is relative to the system and is correlatable across multiple media sources on the same device.

public : IReference<TimeSpan> SystemRelativeTime { get; set; }public Nullable<TimeSpan> SystemRelativeTime { get; set; }Public ReadWrite Property SystemRelativeTime As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

A timestamp relative to the system.

Remarks

Use RelativeTime to get a timestamp that is relative to the video stream.

Type Type Type Type

Gets a string indicating the type of data the frame contains.

public : PlatForm::String Type { get; }public string Type { get; }Public ReadOnly Property Type As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A string indicating the type of data the frame contains.

Methods

Close() Close() Close() Close()

Disposes of the object and associated resources.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()