SceneAnalysisEffect SceneAnalysisEffect SceneAnalysisEffect SceneAnalysisEffect Class

Definition

Represents an effect that analyzes video frames to determine if any of the supported variable photo sequence capture techniques may produce a higher-quality captured image.

public : sealed class SceneAnalysisEffect : ISceneAnalysisEffect, IMediaExtensionpublic sealed class SceneAnalysisEffect : ISceneAnalysisEffect, IMediaExtensionPublic NotInheritable Class SceneAnalysisEffect Implements ISceneAnalysisEffect, IMediaExtension// 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 passing a SceneAnalysisEffectDefinition object into MediaCapture.AddVideoEffectAsync.

Just like other effects, the scene analyzer effect is added to the capture pipeline by calling AddEffectAsync. After capture is started, the SceneAnalyzed event is raised. In the handler for this event, you can get access to the output object that indicates the likelihood that a particular technique will improve the captured image. The output object also provides a set of FrameController objects with recommended settings that can be assigned directly to the VariablePhotoSequenceController.DesiredFrameControllers collection to enable the capture technique.

In the current release, the only analyzer supported is the High Dynamic Range (HDR) analyzer.

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

Properties

DesiredAnalysisInterval DesiredAnalysisInterval DesiredAnalysisInterval DesiredAnalysisInterval

Gets or sets the duration of the time window during which video frames are analyzed.

public : TimeSpan DesiredAnalysisInterval { get; set; }public TimeSpan DesiredAnalysisInterval { get; set; }Public ReadWrite Property DesiredAnalysisInterval As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The duration of the time window during which video frames are analyzed.

HighDynamicRangeAnalyzer HighDynamicRangeAnalyzer HighDynamicRangeAnalyzer HighDynamicRangeAnalyzer

Gets or sets a HighDynamicRangeControl object that is used to enable or disable High Dynamic Range (HDR) analysis.

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

A HighDynamicRangeControl object that is used to enable or disable High Dynamic Range (HDR) analysis.

See Also

Methods

SetProperties(IPropertySet) SetProperties(IPropertySet) SetProperties(IPropertySet) SetProperties(IPropertySet)

Sets properties on the IMediaExtension.

public : void SetProperties(IPropertySet configuration)public void SetProperties(IPropertySet configuration)Public Function SetProperties(configuration As IPropertySet) As void// You can use this method in JavaScript.
Parameters
configuration
IPropertySet IPropertySet IPropertySet IPropertySet

The property set.

Remarks

This method is inherited from the IMediaExtension interface and is not intended to be used from your code. Instead, set the properties of the SceneAnalysisEffect directly.

Events

SceneAnalyzed SceneAnalyzed SceneAnalyzed SceneAnalyzed

Raised when the scene analysis is complete.

public : event TypedEventHandler SceneAnalyzed<SceneAnalysisEffect,  SceneAnalyzedEventArgs>public event TypedEventHandler SceneAnalyzed<SceneAnalysisEffect,  SceneAnalyzedEventArgs>Public Event SceneAnalyzed<SceneAnalysisEffect,  SceneAnalyzedEventArgs>// You can use this event in JavaScript.

See Also