Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

SceneAnalysisEffect Class

Definition

Namespace:
Windows.Media.Core

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 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 ref class SceneAnalysisEffect sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SceneAnalysisEffect final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SceneAnalysisEffect
Public NotInheritable Class SceneAnalysisEffect
Inheritance
Object Platform::Object IInspectable SceneAnalysisEffect
Attributes
Implements

Windows requirements

Requirements Description
Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

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

Name Description
DesiredAnalysisInterval

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

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

Methods

Name Description
SetProperties(IPropertySet)

Sets properties on the IMediaExtension.

Events

Name Description
SceneAnalyzed

Raised when the scene analysis is complete. See SceneAnalyzedEventArgs

Applies to

See also

Feedback

Was this page helpful?