Interface IProvidesFaceTracking
Defines the API for a Face Tracking Provider This functionality provider is responsible for face tracking
Namespace: Unity.MARS.Providers
Syntax
public interface IProvidesFaceTracking : IFunctionalityProviderProperties
CurrentMaximumFaceCount
Gets the current maximum face count. If RequestedMaximumFaceCount set is supported, will reflect that value once the provider has been updated.
Declaration
int CurrentMaximumFaceCount { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
RequestedMaximumFaceCount
Get and set how many faces to track simultaneously. Set may not work for all platforms/providers.
Declaration
int RequestedMaximumFaceCount { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
SupportedFaceCount
The absolute maximum number of faces that can be supported by the provider. -1 if unlimited.
Declaration
int SupportedFaceCount { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
GetFaces(List<IMRFace>)
Get the currently tracked faces
Declaration
void GetFaces(List<IMRFace> faces)Parameters
| Type | Name | Description |
|---|---|---|
| List<IMRFace> | faces | A list of MRFace objects to which the currently tracked faces will be added |
GetMaxFaceCount()
Get the total number of faces that can be tracked by this provider simultaneously
Declaration
int GetMaxFaceCount()Returns
| Type | Description |
|---|---|
| Int32 | The maximum possible number of simultaneously tracked faces, -1 if there is no theoretical limit |
Events
FaceAdded
Called when a face become tracked for the first time
Declaration
event Action<IMRFace> FaceAddedEvent Type
| Type | Description |
|---|---|
| Action<IMRFace> |
FaceRemoved
Called when a tracked face is removed (lost)
Declaration
event Action<IMRFace> FaceRemovedEvent Type
| Type | Description |
|---|---|
| Action<IMRFace> |
FaceUpdated
Called when a tracked face has updated data
Declaration
event Action<IMRFace> FaceUpdatedEvent Type
| Type | Description |
|---|---|
| Action<IMRFace> |