PerceptionDepthFrameSource.TrySetVideoProfileAsync Method

Reference

Definition

Namespace:: Windows.Devices.Perception

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Attempts to set a video profile on this depth frame source. Requires an active Controller Mode control session on this frame source.

public:
 virtual IAsyncOperation<PerceptionFrameSourcePropertyChangeResult ^> ^ TrySetVideoProfileAsync(PerceptionControlSession ^ controlSession, PerceptionVideoProfile ^ profile) = TrySetVideoProfileAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<PerceptionFrameSourcePropertyChangeResult> TrySetVideoProfileAsync(PerceptionControlSession const& controlSession, PerceptionVideoProfile const& profile);

/// [Windows.Foundation.Metadata.RemoteAsync]
/// [Windows.Foundation.Metadata.Deprecated("PerceptionDepthFrameSource may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
IAsyncOperation<PerceptionFrameSourcePropertyChangeResult> TrySetVideoProfileAsync(PerceptionControlSession const& controlSession, PerceptionVideoProfile const& profile);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<PerceptionFrameSourcePropertyChangeResult> TrySetVideoProfileAsync(PerceptionControlSession controlSession, PerceptionVideoProfile profile);

[Windows.Foundation.Metadata.RemoteAsync]
[Windows.Foundation.Metadata.Deprecated("PerceptionDepthFrameSource may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public IAsyncOperation<PerceptionFrameSourcePropertyChangeResult> TrySetVideoProfileAsync(PerceptionControlSession controlSession, PerceptionVideoProfile profile);

function trySetVideoProfileAsync(controlSession, profile)

Public Function TrySetVideoProfileAsync (controlSession As PerceptionControlSession, profile As PerceptionVideoProfile) As IAsyncOperation(Of PerceptionFrameSourcePropertyChangeResult)

Parameters

controlSession: PerceptionControlSession

A PerceptionControlSession representing active control of this frame source.

profile: PerceptionVideoProfile

The video profile to set.

Returns

IAsyncOperation<PerceptionFrameSourcePropertyChangeResult>

This method returns an PerceptionFrameSourcePropertyChangeResult object asynchronously. If the control session was still active when the video profile was set, and if the video profile is supported and can be activated, this will be a result indicating success.

Attributes: RemoteAsyncAttribute DeprecatedAttribute

Applies to