AdvancedCapturedPhoto.FrameBoundsRelativeToReferencePhoto Property

Definition

Namespace:

Windows.Media.Capture

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:
 property IReference<Rect> ^ FrameBoundsRelativeToReferencePhoto { IReference<Rect> ^ get(); };

IReference<Rect> FrameBoundsRelativeToReferencePhoto();

public System.Nullable<Rect> FrameBoundsRelativeToReferencePhoto { get; }

var iReference = advancedCapturedPhoto.frameBoundsRelativeToReferencePhoto;

Public ReadOnly Property FrameBoundsRelativeToReferencePhoto As Nullable(Of Rect)

Property Value

IReference<Rect>

Nullable<Rect>

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

Windows requirements

Device family	Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v3.0)

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.