Package com.onfido

Class LiveVideoManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.LiveVideoManager

public class LiveVideoManager
extends ResourceManager

Manager class for the Live video resource type. Contains resource-specific methods for interacting with the API.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FileDownload	download(String liveVideoId)	Downloads a live video.
FileDownload	downloadFrame(String liveVideoId)	Instead of the whole video, a single frame can be downloaded.
LiveVideo	find(String liveVideoId)	Retrieves a single live video.
List<LiveVideo>	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

LiveVideoManager

protected LiveVideoManager(Config config,
                           okhttp3.OkHttpClient client)

Method Detail

download

public FileDownload download(String liveVideoId)
                      throws OnfidoException

Downloads a live video.

Parameters:

liveVideoId - the live video id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception

downloadFrame

public FileDownload downloadFrame(String liveVideoId)
                           throws OnfidoException

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

Parameters:

liveVideoId - the live video id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception

find

public LiveVideo find(String liveVideoId)
               throws OnfidoException

Retrieves a single live video.

Parameters:

liveVideoId - the live video id

Returns:

the LiveVideo

Throws:

OnfidoException - the onfido exception

list

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

Lists all the live videos that belong to an applicant.

Parameters:

applicantId - the applicant id

Returns:

the list of LiveVideos

Throws:

OnfidoException - the onfido exception