OptionalReferencePhotoCapturedEventArgs OptionalReferencePhotoCapturedEventArgs OptionalReferencePhotoCapturedEventArgs OptionalReferencePhotoCapturedEventArgs Class

Definition

public : sealed class OptionalReferencePhotoCapturedEventArgs : IOptionalReferencePhotoCapturedEventArgspublic sealed class OptionalReferencePhotoCapturedEventArgs : IOptionalReferencePhotoCapturedEventArgsPublic NotInheritable Class OptionalReferencePhotoCapturedEventArgs Implements IOptionalReferencePhotoCapturedEventArgs// 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 handling the AdvancedPhotoCapture.OptionalReferencePhotoCaptured event.

Some devices support returning a reference photo from the capture operation that can be consumed by the calling app before all image frames for the operation have been captured or processed. On devices that do not support returning a reference photo, this event is never raised.

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 reference photo from 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 reference photo.

See Also