AdvancedCapturedPhoto AdvancedCapturedPhoto AdvancedCapturedPhoto AdvancedCapturedPhoto Class

Definition

Represents a photo captured using system-provided computational photography techniques provided by the AdvancedPhotoCapture class.

public : sealed class AdvancedCapturedPhoto : IAdvancedCapturedPhoto, IAdvancedCapturedPhoto2public sealed class AdvancedCapturedPhoto : IAdvancedCapturedPhoto, IAdvancedCapturedPhoto2Public NotInheritable Class AdvancedCapturedPhoto Implements IAdvancedCapturedPhoto, IAdvancedCapturedPhoto2// 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 calling AdvancedPhotoCapture.CaptureAsync.

For how-to guidance for using AdvancedPhotoCapture, see High dynamic range (HDR) and low-light photo capture.

Properties

Context Context Context Context

Gets the app-defined context object associated with the advanced photo capture operation, if one was provided in the call to AdvancedPhotoCapture.CaptureAsync(Object).

public : PlatForm::Object Context { get; }public object Context { get; }Public ReadOnly Property Context As object// You can use this property in JavaScript.
Value
PlatForm::Object object object object

The app-defined context object associated with the advanced photo capture operation.

Remarks

One overload of AdvancedPhotoCapture.CaptureAsync allows you to provide an app-defined object that conveys context information.

Frame Frame Frame Frame

Gets the captured frame containing the result of the advanced photo capture.

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

The captured frame containing the result of the advanced photo capture.

FrameBoundsRelativeToReferencePhoto FrameBoundsRelativeToReferencePhoto FrameBoundsRelativeToReferencePhoto FrameBoundsRelativeToReferencePhoto

Gets a reference to a Rect that expresses the dimensions of the Frame generated by the advanced photo capture operation, relative to the reference photo passed into the OptionalReferencePhotoCaptured event.

public : IReference<Rect> FrameBoundsRelativeToReferencePhoto { get; }public Nullable<Rect> FrameBoundsRelativeToReferencePhoto { get; }Public ReadOnly Property FrameBoundsRelativeToReferencePhoto As Nullable<Rect>// You can use this property in JavaScript.
Value
IReference<Rect> Nullable<Rect> Nullable<Rect> Nullable<Rect>

A reference to a Rect that expresses the frame bounds of the captured frame relative to a reference photo.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Due to the image processing involved, a frame captured with AdvancedPhotoCapture may be smaller than the preview photo that is passed into the OptionalReferencePhotoCaptured event. This property allows you to crop the preview frame so that it matches the dimensions of the processed frame.

Note

Not all capture devices support providing a reference photo for advanced photo capture or determining the dimensions of the reference photo, so this property may be null. Be sure to check for a null reference before using the value of this property.

Mode Mode Mode Mode

Gets a value indicating the advanced capture mode with which the photo was captured.

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

A value indicating the advanced capture mode with which the photo was captured.

See Also