IDLive Face C# API 1.46.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Idrnd.FaceSdk.Pipeline Class Referencesealed

Liveness detection pipeline. More...

Inherits IDisposable.

Public Member Functions

 Pipeline (string pipelineName, InitConfig initConfig)
 Constructor.
 
PipelineResult CheckLiveness (ImageBatch imageBatch, Meta meta)
 Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.
 
PipelineResult CheckLiveness (ImageBatch imageBatch)
 Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.
 
PipelineResult CheckLiveness (Image image, Meta meta)
 Check liveness of face from input image.
 
PipelineResult CheckLiveness (Image image)
 Check liveness of face from input image.
 
OptionalResult< PipelineResult >[] CheckLivenessBatch (Image[] images, Meta[] meta)
 This method implements batched liveness check.
 
OptionalResult< PipelineResult >[] CheckLivenessBatch (Image[] images)
 This method implements batched liveness check.
 

Detailed Description

Liveness detection pipeline.

Constructor & Destructor Documentation

◆ Pipeline()

Idrnd.FaceSdk.Pipeline.Pipeline ( string  pipelineName,
InitConfig  initConfig 
)

Constructor.

Parameters
pipelineNamePipeline name
initConfigConfiguration object

Member Function Documentation

◆ CheckLiveness() [1/4]

PipelineResult Idrnd.FaceSdk.Pipeline.CheckLiveness ( Image  image)

Check liveness of face from input image.

Parameters
imageInput image
Returns
Result of liveness detection

◆ CheckLiveness() [2/4]

PipelineResult Idrnd.FaceSdk.Pipeline.CheckLiveness ( Image  image,
Meta  meta 
)

Check liveness of face from input image.

Parameters
imageInput image
metaMeta information about device
Returns
Result of liveness detection

◆ CheckLiveness() [3/4]

PipelineResult Idrnd.FaceSdk.Pipeline.CheckLiveness ( ImageBatch  imageBatch)

Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.

Parameters
imageBatchInput batch of images (a sequence of photos)
Returns
A single liveness detection result for a given sequence of photos

◆ CheckLiveness() [4/4]

PipelineResult Idrnd.FaceSdk.Pipeline.CheckLiveness ( ImageBatch  imageBatch,
Meta  meta 
)

Perform liveness check on a sequence of photos (image batch). A single results corresponding to the whole image batch will be produced.

Parameters
imageBatchInput batch of images (a sequence of photos)
metaMeta information about device
Returns
A single liveness detection result for a given sequence of photos

◆ CheckLivenessBatch() [1/2]

OptionalResult< PipelineResult >[] Idrnd.FaceSdk.Pipeline.CheckLivenessBatch ( Image[]  images)

This method implements batched liveness check.

Parameters
imagesInput images
Returns
Optional liveness check results. The size of the result array is guaranteed equal to images array size.

◆ CheckLivenessBatch() [2/2]

OptionalResult< PipelineResult >[] Idrnd.FaceSdk.Pipeline.CheckLivenessBatch ( Image[]  images,
Meta[]  meta 
)

This method implements batched liveness check.

Parameters
imagesInput images
metaMeta information about device for all images
Returns
Optional liveness check results. The size of the result array is guaranteed equal to images array size.

The documentation for this class was generated from the following file: