Package com.onfido

Class MotionCaptureManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.MotionCaptureManager

public class MotionCaptureManager
extends ResourceManager

Manager class for the Motion capture resource type. Contains resource-specific methods for interacting with the API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MotionCaptureManager(Config config, okhttp3.OkHttpClient client)

Method Summary

Modifier and Type	Method	Description
FileDownload	download(String motionCaptureId)	Downloads a motion capture.
FileDownload	downloadFrame(String motionCaptureId)	Instead of the whole motion capture, a single frame can be downloaded.
MotionCapture	find(String motionCaptureId)	Retrieves a single motion capture.
List<MotionCapture>	list(String applicantId)	Lists all the live videos that belong to an applicant.

Methods inherited from class com.onfido.api.ResourceManager

addFormDataParam, deleteRequest, downloadRequest, get, post, put, readInputStream, uploadRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MotionCaptureManager

protected MotionCaptureManager(Config config,
                               okhttp3.OkHttpClient client)

Method Detail

download

public FileDownload download(String motionCaptureId)
                      throws OnfidoException

Downloads a motion capture.

Parameters:

motionCaptureId - the motion capture id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception

downloadFrame

public FileDownload downloadFrame(String motionCaptureId)
                           throws OnfidoException

Instead of the whole motion capture, a single frame can be downloaded.

Parameters:

motionCaptureId - the motion capture id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception

find

public MotionCapture find(String motionCaptureId)
                   throws OnfidoException

Retrieves a single motion capture.

Parameters:

motionCaptureId - the motion capture id

Returns:

the MotionCapture

Throws:

OnfidoException - the onfido exception

list

public List<MotionCapture> list(String applicantId)
                         throws OnfidoException

Lists all the live videos that belong to an applicant.

Parameters:

applicantId - the applicant id

Returns:

the list of MotionCaptures

Throws:

OnfidoException - the onfido exception