PerceptionFrameProviderManagerService PerceptionFrameProviderManagerService PerceptionFrameProviderManagerService PerceptionFrameProviderManagerService Class

Definition

Static methods for managing IPerceptionFrameProvider registration and unregistration, PerceptionFaceAuthenticationGroup registration and unregistration, PerceptionControlGroup registration and unregistration, PerceptionCorrelationGroup registration and unregistration, IPerceptionFrameProvider availablity, and publishing a new PerceptionFrame for an IPerceptionFrameProvider.

public : static class PerceptionFrameProviderManagerServicepublic static class PerceptionFrameProviderManagerServicePublic Static Class PerceptionFrameProviderManagerService// 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)

Methods

PublishFrameForProvider(IPerceptionFrameProvider, PerceptionFrame) PublishFrameForProvider(IPerceptionFrameProvider, PerceptionFrame) PublishFrameForProvider(IPerceptionFrameProvider, PerceptionFrame) PublishFrameForProvider(IPerceptionFrameProvider, PerceptionFrame)

Sends the PerceptionFrame to the service to tell any apps listening for frames for the provided provider. Frames aren't expected to be published before IPerceptionFrameProvider::Start() is called or after IPerceptionFrameProvider::Stop() is called.

public : static void PublishFrameForProvider(IPerceptionFrameProvider provider, PerceptionFrame frame)public static void PublishFrameForProvider(IPerceptionFrameProvider provider, PerceptionFrame frame)Public Static Function PublishFrameForProvider(provider As IPerceptionFrameProvider, frame As PerceptionFrame) As void// You can use this method in JavaScript.
Parameters
provider
IPerceptionFrameProvider IPerceptionFrameProvider IPerceptionFrameProvider IPerceptionFrameProvider

The IPerceptionFrameProvider which produced the frame.

frame
PerceptionFrame PerceptionFrame PerceptionFrame PerceptionFrame

The PerceptionFrame that was produced and should be sent to apps.

RegisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup) RegisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup) RegisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup) RegisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup)

Registers a PerceptionControlGroup associated with the IPerceptionFrameProviderManager.

public : static void RegisterControlGroup(IPerceptionFrameProviderManager manager, PerceptionControlGroup controlGroup)public static void RegisterControlGroup(IPerceptionFrameProviderManager manager, PerceptionControlGroup controlGroup)Public Static Function RegisterControlGroup(manager As IPerceptionFrameProviderManager, controlGroup As PerceptionControlGroup) As void// You can use this method in JavaScript.
Parameters
controlGroup
PerceptionControlGroup PerceptionControlGroup PerceptionControlGroup PerceptionControlGroup

The group of IPerceptionFrameProvider(s) to control atomically.

Remarks

The PerceptionControlGroup's ids used to create it can't appear in a PerceptionControlGroup which is already registered. Doing so raises an InvalidArgumentException.

The PerceptionControlGroup specifies which IPerceptionFrameProvider(s) will be arbitrated for control together when control is successfully requested by an app and revoked when control is revoked from the app.

When a PerceptionControlSession is acquired for a PerceptionControlGroup, that app may set properties on each provider in the group. Before the IPerceptionFrameProvider is registered in a control group, attempts to control it will fail and properties can't be set.

RegisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup) RegisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup) RegisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup) RegisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup)

Registers a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager.

public : static void RegisterCorrelationGroup(IPerceptionFrameProviderManager manager, PerceptionCorrelationGroup correlationGroup)public static void RegisterCorrelationGroup(IPerceptionFrameProviderManager manager, PerceptionCorrelationGroup correlationGroup)Public Static Function RegisterCorrelationGroup(manager As IPerceptionFrameProviderManager, correlationGroup As PerceptionCorrelationGroup) As void// You can use this method in JavaScript.
Parameters
correlationGroup
PerceptionCorrelationGroup PerceptionCorrelationGroup PerceptionCorrelationGroup PerceptionCorrelationGroup

The group of PerceptionCorrelations(s) to control atomically.

Remarks

This method enables finding correlated intrinsics and mappings to project and unproject frames between two correlated IPerceptionFrameProviders. Providers that aren't directly correlated together will not be correlatable with each other. An InvalidArgumentException is raised if a provider is in more than one registered PerceptionCorrelationGroup.

RegisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup) RegisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup) RegisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup) RegisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup)

Registers a PerceptionFaceAuthenticationGroup associated with the given IPerceptionProviderManager.

public : static void RegisterFaceAuthenticationGroup(IPerceptionFrameProviderManager manager, PerceptionFaceAuthenticationGroup faceAuthenticationGroup)public static void RegisterFaceAuthenticationGroup(IPerceptionFrameProviderManager manager, PerceptionFaceAuthenticationGroup faceAuthenticationGroup)Public Static Function RegisterFaceAuthenticationGroup(manager As IPerceptionFrameProviderManager, faceAuthenticationGroup As PerceptionFaceAuthenticationGroup) As void// You can use this method in JavaScript.
Parameters
faceAuthenticationGroup
PerceptionFaceAuthenticationGroup PerceptionFaceAuthenticationGroup PerceptionFaceAuthenticationGroup PerceptionFaceAuthenticationGroup

The group of IPerceptionFrameProvider(s) to atomically control.

RegisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo) RegisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo) RegisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo) RegisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo)

Registers the PerceptionFrameProviderInfo in association with the given IPerceptionFrameProviderManager.

public : static void RegisterFrameProviderInfo(IPerceptionFrameProviderManager manager, PerceptionFrameProviderInfo frameProviderInfo)public static void RegisterFrameProviderInfo(IPerceptionFrameProviderManager manager, PerceptionFrameProviderInfo frameProviderInfo)Public Static Function RegisterFrameProviderInfo(manager As IPerceptionFrameProviderManager, frameProviderInfo As PerceptionFrameProviderInfo) As void// You can use this method in JavaScript.
Parameters
manager
IPerceptionFrameProviderManager IPerceptionFrameProviderManager IPerceptionFrameProviderManager IPerceptionFrameProviderManager

The manager which can provide the IPerceptionFrameProvider associated with the info.

frameProviderInfo
PerceptionFrameProviderInfo PerceptionFrameProviderInfo PerceptionFrameProviderInfo PerceptionFrameProviderInfo

The PerceptionFrameProviderInfo which identifies the available IPerceptionFrameProvider.

Remarks

This method enables the service to request the IPerceptionFrameProvider associated with the PerceptionFrameProviderInfo. The IPerceptionFrameProviderManager will be queried via IPerceptionFrameProviderManager::GetFrameProvider() to get the associated IPerceptionFrameProvider.

UnregisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup) UnregisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup) UnregisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup) UnregisterControlGroup(IPerceptionFrameProviderManager, PerceptionControlGroup)

Removes the registration of a previously registered PerceptionControlGroup.

public : static void UnregisterControlGroup(IPerceptionFrameProviderManager manager, PerceptionControlGroup controlGroup)public static void UnregisterControlGroup(IPerceptionFrameProviderManager manager, PerceptionControlGroup controlGroup)Public Static Function UnregisterControlGroup(manager As IPerceptionFrameProviderManager, controlGroup As PerceptionControlGroup) As void// You can use this method in JavaScript.
Parameters
controlGroup
PerceptionControlGroup PerceptionControlGroup PerceptionControlGroup PerceptionControlGroup

The group of IPerceptionFrameProvider(s) to prevent from being controlled.

Remarks

The service will no longer call IPerceptionFrameProviders::SetProperty() for any Frame provider in the group. After unregistering one control group, the members may be reregistered via the same or different control group(s).

UnregisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup) UnregisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup) UnregisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup) UnregisterCorrelationGroup(IPerceptionFrameProviderManager, PerceptionCorrelationGroup)

Unregisters a PerceptionCorrelationGroup associated with the IPerceptionFrameProviderManager.

public : static void UnregisterCorrelationGroup(IPerceptionFrameProviderManager manager, PerceptionCorrelationGroup correlationGroup)public static void UnregisterCorrelationGroup(IPerceptionFrameProviderManager manager, PerceptionCorrelationGroup correlationGroup)Public Static Function UnregisterCorrelationGroup(manager As IPerceptionFrameProviderManager, correlationGroup As PerceptionCorrelationGroup) As void// You can use this method in JavaScript.
Parameters

Remarks

The IPerceptionFrameProviders in the list no longer will have any correlation with each other. The group or any subset may be registered again after Unregistration completes.

UnregisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup) UnregisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup) UnregisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup) UnregisterFaceAuthenticationGroup(IPerceptionFrameProviderManager, PerceptionFaceAuthenticationGroup)

Unregisters a PerceptionFaceAuthenticationGroup in association with the given IPerceptionProviderManager.

public : static void UnregisterFaceAuthenticationGroup(IPerceptionFrameProviderManager manager, PerceptionFaceAuthenticationGroup faceAuthenticationGroup)public static void UnregisterFaceAuthenticationGroup(IPerceptionFrameProviderManager manager, PerceptionFaceAuthenticationGroup faceAuthenticationGroup)Public Static Function UnregisterFaceAuthenticationGroup(manager As IPerceptionFrameProviderManager, faceAuthenticationGroup As PerceptionFaceAuthenticationGroup) As void// You can use this method in JavaScript.
Parameters

Remarks

This stops the providers in the group from being requested to enter Face Authentication mode or being used for Face Authentication until it's registered again. The group or any subset of it may be registered again after being unregistered.

UnregisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo) UnregisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo) UnregisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo) UnregisterFrameProviderInfo(IPerceptionFrameProviderManager, PerceptionFrameProviderInfo)

Unregisters the PerceptionFrameProviderInfo in association with the given IPerceptionProviderManager.

public : static void UnregisterFrameProviderInfo(IPerceptionFrameProviderManager manager, PerceptionFrameProviderInfo frameProviderInfo)public static void UnregisterFrameProviderInfo(IPerceptionFrameProviderManager manager, PerceptionFrameProviderInfo frameProviderInfo)Public Static Function UnregisterFrameProviderInfo(manager As IPerceptionFrameProviderManager, frameProviderInfo As PerceptionFrameProviderInfo) As void// You can use this method in JavaScript.
Parameters
frameProviderInfo
PerceptionFrameProviderInfo PerceptionFrameProviderInfo PerceptionFrameProviderInfo PerceptionFrameProviderInfo

The PerceptionFrameProviderInfo which identifies the IPerceptionFrameProvider.

Remarks

After this function returns, the service no longer calls the IPerceptionFrameProviderManager::GetFrameProvider() method with the provided PerceptionFrameProviderInfo. Unregistering a PerceptionFrameProviderInfo that is not registered, because it was never registered or because it's already unregistered, raises an InvalidArgumentException.

UpdateAvailabilityForProvider(IPerceptionFrameProvider, Boolean) UpdateAvailabilityForProvider(IPerceptionFrameProvider, Boolean) UpdateAvailabilityForProvider(IPerceptionFrameProvider, Boolean) UpdateAvailabilityForProvider(IPerceptionFrameProvider, Boolean)

Sets whether or not the IPerceptionFrameProvider is available.

public : static void UpdateAvailabilityForProvider(IPerceptionFrameProvider provider, bool available)public static void UpdateAvailabilityForProvider(IPerceptionFrameProvider provider, Boolean available)Public Static Function UpdateAvailabilityForProvider(provider As IPerceptionFrameProvider, available As Boolean) As void// You can use this method in JavaScript.
Parameters
available
bool Boolean Boolean Boolean

Whether or not the provider is available.

Remarks

Available providers are expected to be able to provide frames while unavailable providers aren't. Before calling this method, a provider is assumed to be available if registered.