Share via


PerceptionColorFrameArrivedEventArgs.TryOpenFrame Method

Definition

Attempts to open the color frame that has arrived.

public:
 virtual PerceptionColorFrame ^ TryOpenFrame() = TryOpenFrame;
PerceptionColorFrame TryOpenFrame();
/// [Windows.Foundation.Metadata.Deprecated("PerceptionColorFrameArrivedEventArgs may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
PerceptionColorFrame TryOpenFrame();
public PerceptionColorFrame TryOpenFrame();
[Windows.Foundation.Metadata.Deprecated("PerceptionColorFrameArrivedEventArgs may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameArrivedEventArgs instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public PerceptionColorFrame TryOpenFrame();
function tryOpenFrame()
Public Function TryOpenFrame () As PerceptionColorFrame

Returns

If the attempt is successful, this method returns the newly-arrived color frame. If the attempt is unsuccessful, this value is unchanged.

Attributes

Remarks

Existing frames should be closed before opening new frames. If an app has three or more frames still open when this method is called, TryOpenFrame will fail.

Applies to