SceneAnalysisEffectFrame SceneAnalysisEffectFrame SceneAnalysisEffectFrame SceneAnalysisEffectFrame Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a video frame that includes the results of the scene analysis operation.

public : sealed class SceneAnalysisEffectFrame : IClosable, ISceneAnalysisEffectFrame, IMediaFramepublic sealed class SceneAnalysisEffectFrame : IDisposable, ISceneAnalysisEffectFrame, IMediaFramePublic NotInheritable Class SceneAnalysisEffectFrame Implements IDisposable, ISceneAnalysisEffectFrame, 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 handling the SceneAnalysisEffect.SceneAnalyzed event.

For how-to guidance on using the SceneAnalysisEffect, see Scene anlysis for MediaCapture.

Properties

AnalysisRecommendation AnalysisRecommendation AnalysisRecommendation AnalysisRecommendation

Prerelease. Gets a value that specifies the recommended image processing to improve image quality and fidelity of captured images based on the current capture conditions.

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

A value from that specifies the recommended image processing.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the effect recommends using HDR, you can do this in the following ways:

If the effect recomends low-light processing, you can implement this in the following ways:

Duration Duration Duration Duration

Gets or sets the duration of the scene analysis 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 scene analysis 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.

FrameControlValues FrameControlValues FrameControlValues FrameControlValues

Gets a CapturedFrameControlValues object that indicates the capture settings used for the frame.

public : CapturedFrameControlValues FrameControlValues { get; }public CapturedFrameControlValues FrameControlValues { get; }Public ReadOnly Property FrameControlValues As CapturedFrameControlValues// You can use this property in JavaScript.

HighDynamicRange HighDynamicRange HighDynamicRange HighDynamicRange

Gets a HighDynamicRangeOutput object that provides recommended FrameController objects and a value indicating the certainty of the HDR analysis.

public : HighDynamicRangeOutput HighDynamicRange { get; }public HighDynamicRangeOutput HighDynamicRange { get; }Public ReadOnly Property HighDynamicRange As HighDynamicRangeOutput// You can use this property in JavaScript.

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()

See Also