PerceptionPropertyChangeRequest PerceptionPropertyChangeRequest PerceptionPropertyChangeRequest PerceptionPropertyChangeRequest Class

Definition

A request from an app that's in control of this IPerceptionFrameProvider to update a property.

public : sealed class PerceptionPropertyChangeRequest : IPerceptionPropertyChangeRequestpublic sealed class PerceptionPropertyChangeRequest : IPerceptionPropertyChangeRequestPublic NotInheritable Class PerceptionPropertyChangeRequest Implements IPerceptionPropertyChangeRequest// 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)

Properties

Name Name Name Name

Gets the name of the property to change.

public : PlatForm::String Name { get; }public string Name { get; }Public ReadOnly Property Name As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The name of the property to change.

Status Status Status Status

Sets the new status of the request after processing the request.

public : PerceptionFrameSourcePropertyChangeStatus Status { get; set; }public PerceptionFrameSourcePropertyChangeStatus Status { get; set; }Public ReadWrite Property Status As PerceptionFrameSourcePropertyChangeStatus// You can use this property in JavaScript.

Remarks

The value should be set as follows:

  • Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::Accepted – The property has been updated to the new value.
  • Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::PropertyNotSupported – The property is not supported on this IPerceptionFrameProvider and can't be set.
  • Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::PropertyReadOnly – The property is supported on this IPerceptionFrameProvider but can't be changed.
  • Windows::Devices::Perception::PerceptionFrameSourcePropertyChangeStatus::ValueOutOfRange – The property is supported on this IPerceptionFrameProvider but the provided new value is outside of the range of accepted values.

Value Value Value Value

Gets the requested new value of the property.

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

The requested new value of the property.

Methods

GetDeferral() GetDeferral() GetDeferral() GetDeferral()

Gets a Windows::Foundation::Deferral object to allow background processing if needed.

public : Deferral GetDeferral()public Deferral GetDeferral()Public Function GetDeferral() As Deferral// You can use this method in JavaScript.
Returns

The Deferral object.

Remarks

When doing background processing, call GetDeferral() and store the result as well as the * PerceptionPropertyChangeRequest. When background processing is complete, set the Status on the PerceptionPropertyChangeRequest and call Complete() on the deferral before removing references to the objects.