SceneAnalysisEffectFrame SceneAnalysisEffectFrame SceneAnalysisEffectFrame SceneAnalysisEffectFrame SceneAnalysisEffectFrame Class


Represents a video frame that includes the results of the scene analysis operation.

public : sealed class SceneAnalysisEffectFrame : IClosable, IMediaFrame
struct winrt::Windows::Media::Core::SceneAnalysisEffectFrame : IClosable, IMediaFrame
public sealed class SceneAnalysisEffectFrame : IDisposable, IMediaFrame
Public NotInheritable Class SceneAnalysisEffectFrame Implements IDisposable, IMediaFrame
// This class does not provide a public constructor.

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)


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.

Version history

Windows version SDK version Value added
1709 16299 AnalysisRecommendation


AnalysisRecommendation AnalysisRecommendation AnalysisRecommendation AnalysisRecommendation AnalysisRecommendation

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

Duration Duration Duration Duration Duration

Gets or sets the duration of the scene analysis effect frame.

ExtendedProperties ExtendedProperties ExtendedProperties ExtendedProperties ExtendedProperties

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

FrameControlValues FrameControlValues FrameControlValues FrameControlValues FrameControlValues

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

HighDynamicRange HighDynamicRange HighDynamicRange HighDynamicRange HighDynamicRange

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

IsDiscontinuous 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.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly IsReadOnly

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

RelativeTime RelativeTime RelativeTime RelativeTime RelativeTime

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

SystemRelativeTime 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.

Type Type Type Type Type

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


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

Disposes of the object and associated resources.

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

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

See also