Android SDK Methods and Properties
OzLivenessSDK
A singleton for Oz SDK.
clearActionVideos
Deletes all action videos from file system.
Parameters
-
Returns
-
createStartIntent
Creates an intent to start the Liveness activity.
Returns
-
getErrorFromIntent
Utility function to get the SDK error from OnActivityResult's intent.
Returns
The error text – String.
getLicensePayload
Retrieves the SDK license payload.
Parameters
-
Returns
The license payload (LicensePayload) – the object that contains the extended info about licensing conditions.
getResultFromIntent
Utility function to get SDK results from OnActivityResult's intent.
Returns
A list of OzAbstractMedia objects.
init
Initializes SDK with license sources.
Returns
-
log
Enables logging using the Oz Liveness SDK logging mechanism.
Returns
-
setApiConnection
Connection to API.
setEventsConnection
Connection to the telemetry server.
logout
Deletes the saved token.
Parameters
-
Returns
-
getEventSessionId
Retrieves the telemetry session ID.
Parameters
-
Returns
The telemetry session ID (String parameter).
version
Retrieves the SDK version.
Parameters
-
Returns
The SDK version (String parameter).
generateSignedPayload
Generates the payload with media signatures.
Returns
Payload to be sent along with media files that were used for generation.
AnalysisRequest
A class for performing checks.
run
The analysis launching method.
class Builder
A builder class for AnalysisRequest.
build
Creates the AnalysisRequest instance.
Parameters
-
Returns
The AnalysisRequest class instance.
addAnalysis
Adds an analysis to your request.
Returns
Error if any.
addAnalyses
Adds a list of analyses to your request. Allows executing several analyses for the same folder on the server side.
Returns
Error if any.
addFolderMeta
Adds metadata to a folder you create (for the server-based analyses only). You can add a pair key-value as additional information to the folder with the analysis result on the server side.
Returns
Error if any.
uploadMedia
Uploads one or more media to a folder.
Returns
Error if any.
setFolderId
For the previously created folder, sets a folderId. The folder should exist on the server side. Otherwise, a new folder will be created.
Returns
Error if any.
OzConfig
Configuration for OzLivenessSDK (use OzLivenessSDK.config).
setSelfieLength
Sets the length of the Selfie gesture (in milliseconds).
Returns
Error if any.
allowDebugVisualization
The possibility to enable additional debug info by clicking on version text.
attemptSettings
The number of attempts before SDK returns error.
uploadMediaSettings
Settings for repeated media upload.
faceAlignmentTimeout
Timeout for face alignment (measured in milliseconds).
livenessErrorCallback
Interface implementation to retrieve error by Liveness detection.
localizationCode
Locale to display string resources.
logging
Logging settings.
useMainCamera
Uses the main (rear) camera instead of the front camera for liveness detection.
UICustomization
Customization for OzLivenessSDK (use OzLivenessSDK.config.customization
).
hideStatusBar
Hides the status bar and the three buttons at the bottom. The default value is True
.
toolbarCustomization
A set of customization parameters for the toolbar.
centerHintCustomization
A set of customization parameters for the center hint that guides a user through the process of taking an image of themselves.
hintAnimation
A set of customization parameters for the hint animation.
faceFrameCustomization
A set of customization parameters for the frame around the user face.
backgroundCustomization
A set of customization parameters for the background outside the frame.
versionTextCustomization
A set of customization parameters for the SDK version text.
antiscamCustomization
A set of customization parameters for the antiscam message that warns user about their actions being recorded.
logoCustomization
Logo customization parameters. Custom logo should be allowed by license.
Variables and Objects
enum OzAction
Contains the action from the captured video.
class LicensePayload
Contains the extended info about licensing conditions.
sealed class OzAbstractMedia
A class for the captured media that can be:
OzDocumentPhoto
A document photo.
OzShotSet
A set of shots in an archive.
OzVideo
A Liveness video.
enum OzMediaTag
Contains an action from the captured video.
sealed class LicenseSource
A class for license that can be:
LicenseAssetId
Contains the license ID.
LicenseFilePath
Contains the path to a license.
class AnalysisStatus
A class for analysis status that can be:
RunningAnalysis
This status means the analysis is launched.
UploadingMedia
This status means the media is being uploaded.
enum Type
The type of the analysis.
Currently, the DOCUMENTS
analysis can't be performed in the on-device mode.
enum Mode
The mode of the analysis.
class Analysis
Contains information on what media to analyze and what analyses to apply.
enum Resolution
The general status for all analyses applied to the folder created.
class OzAttemptsSettings
Holder for attempts counts before SDK returns error.
enum OzLocalizationCode
Contains the locale code according to ISO 639-1.
class OzLogging
Contains logging settings.
sealed class Color
A class for color that can be (depending on the value received):
ColorRes
ColorHex
ColorInt
enum GeometryType
Frame shape settings.
class AnalysisError
Exception class for AnalysisRequest.
class SourceMedia
Structure that describes media used in AnalysisRequest.
class ResultMedia
Structure that describes the analysis result for the single media.
class RequestResult
Consolidated result for all analyses performed.
class AnalysisResult
Result of the analysis for all media it was applied to.
class OzConnection
Defines the authentication method.
OzConnection.fromServiceToken
Authentication via token.
OzConnection.fromCredentials
Authentication via credentials.
class OzUploadMediaSettings
Defines the settings for the repeated media upload.
enum SizeReductionStrategy
Defines what type of media is being sent to the server in case of the hybrid analysis once the on-device analysis is finished successfully. By default, the system uploads the compressed video.
Error Description
Last updated