Методы и поля Android SDK
OzLivenessSDK
Синглтон (шаблон-одиночка) для Oz SDK.
clearActionVideos
Удаляет все видеоролики.
Параметры
-
Возвращает
-
createStartIntent
Создает намерение (intent) для запуска Liveness.
Параметр
Тип
Описание
actions
Список возможных действий
Возвращает
-
getErrorFromIntent
Запрашивает ошибку из намерения (intent) OnActivityResult (при наличии).
Параметр
Тип
Описание
data
Intent
Проверяемое намерение
Возвращает
Текст ошибки.
getLicensePayload
Запрашивает информацию о лицензии SDK.
Параметры
-
Возвращает
Полную информацию о лицензии – объект LicensePayload.
getResultFromIntent
Запрашивает медиафайлы из намерения (intent) OnActivityResult.
Параметр
Тип
Описание
data
Intent
Проверяемое намерение
Возвращает
Массив объектов OzAbstractMedia.
init
Инициализирует SDK, используя данные лицензии.
Параметр
Тип
Описание
context
Context
Базовый класс Context
licenseSources
Список источников лицензий
statusListener (опционально)
StatusListener
Обработчик для проверки результата
Возвращает
-
log
Включает журналирование, запуская соответствующие механизмы Oz Liveness SDK.
Параметр
Тип
Описание
tag
String
Метка сообщения
log
String
Тело сообщения
Возвращает
-
setApiConnection
Подключение к API.
Параметр
Тип
Описание
connection
Тип подключения
statusListener
StatusListener<String?>
Обработчик
setEventsConnection
Подключение к серверу телеметрии.
Параметр
Тип
Описание
connection
Тип подключения
statusListener
StatusListener<String?>
Обработчик
logout
Удаляет сохраненный токен.
Параметры
-
Возвращает
-
getEventSessionId
Запрашивает идентификатор сессии телеметрии.
Параметры
-
Возвращает
Идентификатор сессии телеметрии (String).
version
Запрашивает версию SDK.
Параметры
-
Возвращает
Номер версии SDK (String).
generateSignedPayload
Создает payload с подписями медиафайлов.
Параметр
Тип
Описание
media
Массив медиафайлов
folderMeta (опционально)
[String: any]
Дополнительные метаданные папки
Возвращает
payload для загрузки вместе с медиафайлами, для которых он был сгенерирован.
AnalysisRequest
Класс для выполнения проверок.
run
Запускает анализы.
Параметр
Тип
Описание
onStatusChange
,
Callback-функция:
onStatusChange(status: AnalysisRequest.AnalysisStatus) { handleStatus() }
onError
Callback-функция:
onError(error: OzException) { handleError() }
Вызывается в случае ошибки.
onSuccess
Callback-функция:
onSuccess(result: RequestResult) {
handleResults() }
class Builder
Конструктор для AnalysisRequest.
build
Создает AnalysisRequest.
Параметры
-
Возвращает
Экземпляр класса AnalysisRequest.
addAnalysis
Добавляет в запрос анализ.
Параметр
Тип
Описание
analysis
Структура с данными об анализе
Возвращает
Ошибку в случае ее появления.
addAnalyses
Добавляет в запрос список анализов (можно назначить несколько анализов для одной папки).
Параметр
Тип
Описание
analysis
Массив структур Analysis
Возвращает
Ошибку в случае ее появления.
addFolderMeta
Добавляет метаданные в создаваемую папку (только для анализа на сервере).
Параметр
Тип
Описание
key
String
Ключ
value
String
Значение
Возвращает
Ошибку в случае ее появления.
uploadMedia
Добавляет один или несколько медиафайлов в папку для последующего выполнения проверок.
Параметр
Тип
Описание
mediaList
Объект или массив объектов OzAbstractMedia
Возвращает
Ошибку в случае ее появления.
setFolderId
Устанавливает идентификатор для ранее созданной папки. Эта папка должна существовать на сервере, иначе создастся новая.
Параметр
Тип
Описание
folderID
String
Идентификатор папки
Возвращает
Ошибку в случае ее появления.
OzConfig
Конфигурация OzLivenessSDK (используйте OzLivenessSDK.config).
setSelfieLength
Устанавливает длительность жеста Селфи (в миллисекундах).
Параметр
Тип
Описание
selfieLength
Int
Длительность жеста Селфи (в миллисекундах). Должна быть в пределах 500-5000, по умолчанию – 700
Возвращает
Ошибку в случае ее появления.
allowDebugVisualization
Возможность отображать дополнительную отладочную информацию при нажатии на текст версии.
Параметр
Тип
Описание
allowDebugVisualization
Boolean
Включает / выключает отображение дополнительной информации
attemptSettings
Количество попыток выполнить анализы, после которого SDK выдаст ошибку.
Параметр
Тип
Описание
attemptsSettings
Количество попыток
baseURL
URL сервера API для работы с телеметрией.
Параметр
Тип
Описание
baseURL
String
Адрес сервера
faceAlignmentTimeout
Время, в течение которого нужно поместить лицо в рамку и выполнить жест (в миллисекундах).
Параметр
Тип
Описание
faceAlignmentTimeout
Long
Значение тайм-аута
uploadMediaSettings
Настройки повторной отправки медиафайлов.
Parameter
Type
Description
uploadMediaSettings
Устанавливает количество попыток и интервал между ними
livenessErrorCallback
Интерфейс для обработки ошибок.
Параметр
Тип
Описание
livenessErrorCallback
ErrorHandler
Callback для обработки ошибок
localizationCode
Локализация текста.
Параметр
Тип
Описание
localizationCode
Код языка SDK
logging
Настройки журналирования.
Параметр
Тип
Описание
logging
Настройки журналирования
useMainCamera
Включает использование основной (задней) камеры для съемки вместо фронтальной.
Параметр
Тип
Описание
useMainCamera
Boolean
True – используется основная камера,
False – фронтальная
UICustomization
Настройки кастомизации OzLivenessSDK (используйте OzLivenessSDK.config.customization).
hideStatusBar
Скрывает системные части экрана: полосу статуса и кнопки. По умолчанию имеет значение True.
toolbarCustomization
Настройки кастомизации верхней панели.
Параметр
Тип
Описание
closeIconRes
Int (@DrawableRes)
Иконка кнопки закрытия
closeIconTint
Цвет кнопки закрытия
titleTextFont
Int (@FontRes)
Шрифт текста на верхней панели
titleTextFontStyle
Int (значения из android.graphics.Typeface, например Typeface.BOLD)
Стиль шрифта текста на верхней панели
titleTextSize
Int
Размер текста на верхней панели (в sp, 12-18)
titleTextAlpha
Int
Непрозрачность текста на верхней панели (в %, 0-100)
titleTextColor
Цвет текста на верхней панели
backgroundColor
Цвет фона верхней панели
backgroundAlpha
Int
Непрозрачность фона верхней панели (в %, 0-100)
isTitleCentered
Boolean
Центрирует текст на верхней панели
title
String
Текст на верхней панели
centerHintCustomization
Настройки кастомизации текста подсказки, ориентируясь на который, пользователь снимает фото или видео.
Параметр
Тип
Описание
textFont
String
Шрифт текста подсказки
textStyle
Int (значения из android.graphics.Typeface, например Typeface.BOLD)
Стиль текста подсказки
textSize
Int
Размер шрифта текста подсказки (в sp, 12-34)
textColor
Цвет текста подсказки
textAlpha
Int
Непрозрачность текста подсказки (в %, 0-100)
verticalPosition
Int
Положение подсказки по вертикали (от нижнего края экрана, в %, 0-100)
backgroundColor
Цвет фона
backgroundOpacity
Int
Непрозрачность фона
backgroundCornerRadius
Int
Радиус скругления углов рамки фона (в dp, 0-20)
hintAnimation
Настройки кастомизации для анимации подсказки.
Параметр
Тип
Описание
hintGradientColor
Цвет градиента
hintGradientOpacity
Int
Непрозрачность градиента
animationIconSize
Int
Размер квадрата, в который вписан значок анимации
hideAnimation
Boolean
Настройки скрытия анимации, при значении True анимация скрывается
faceFrameCustomization
Настройки кастомизации рамки вокруг лица.
Параметр
Тип
Описание
geometryType
Форма рамки (oval, rectangle, circle или square)
cornerRadius
Int
Угловой радиус прямоугольника (в dp, 0-20)
strokeDefaultColor
Цвет рамки, когда лицо не в кадре
strokeFaceInFrameColor
Цвет рамки, когда лицо в кадре
strokeAlpha
Int
Непрозрачность рамки (в %, 0-100)
strokeWidth
Int
Толщина линии (в dp, 0-20)
strokePadding
Int
Отступ от рамки до овала, куда нужно поместить лицо (в dp, 0-10)
backgroundCustomization
Настройки кастомизации фона за рамкой.
Параметр
Тип
Описание
backgroundColor
Цвет фона
backgroundAlpha
Int
Непрозрачность фона (в %, 0-100)
versionTextCustomization
Настройки кастомизации текста версии SDK.
Параметр
Тип
Описание
textFont
Int (@FontRes)
Шрифт текста версии SDK
textSize
Int
SDK version text size (в sp, 12-16)
textColor
Цвет текста версии SDK
textAlpha
Int
Непрозрачность текста версии SDK (в %, 20-100)
antiscamCustomization
Настройки кастомизации для защиты от мошенничества (сообщение о том, что идет запись).
Параметр
Тип
Описание
textMessage
String
Текст сообщения
textFont
String
Шрифт текста сообщения
textSize
Int
Размер шрифта сообщения (в px, 12-18)
textColor
Цвет текста сообщения
textAlpha
Int
Непрозрачность текста сообщения (в %, 0-100)
backgroundColor
Цвет фона сообщения
backgroundOpacity
Int
Непрозрачность фона сообщения
cornerRadius
Int
Радиус скругления углов рамки фона (в px, 0-20)
flashColor
Цвет мигающего индикатора рядом с сообщением
logoCustomization
Параметры настройки логотипа, если лицензия предусматривает возможность его изменения.
Parameter
Type
Description
image
Bitmap (@DrawableRes)
Изображение для лого
size
Size
Размер лого (в dp)
Переменные и объекты
enum OzAction
Действие, представленное на видео.
Значение
Описание
OneShot
Лучший кадр из снятого видео
Blank
Селфи с проверкой позиционирования лица
Scan
Сканирование
HeadRight
Поворот головы направо
HeadLeft
Поворот головы налево
HeadDown
Наклон головы вниз
HeadUp
Подъем головы вверх
EyeBlink
Моргание
Smile
Улыбка
class LicensePayload
Содержит расширенную информацию о параметрах лицензии.
Параметр
Тип
Описание
expires
Float
Период времени, спустя который срок действия лицензии истечет
features
Features
Особенности лицензии
appIDS
[String]
Массив идентификаторов приложений
sealed class OzAbstractMedia
Класс для снятого фото или видео, может быть:
OzDocumentPhoto
Фото документа.
Параметр
Тип
Описание
tag
Тег для фото документа
photoPath
String
Абсолютный путь к фото
additionalTags (опционально)
String
Дополнительные теги, если требуются (в том числе не из перечисления OzMediaTag)
metaData
Map<String, String>
Метаданные медиафайла
OzShotSet
Набор кадров (shot set) в архиве.
Параметр
Тип
Описание
tag
Тег для shot set
archivePath
String
Путь к архиву
additionalTags (опционально)
String
Дополнительные теги, если требуются (в том числе не из перечисления OzMediaTag)
metaData
Map<String, String>
Метаданные медиафайла
OzVideo
Видео с проверкой Liveness.
Параметр
Тип
Описание
tag
Тег видео
videoPath
String
URL видео с проверкой Liveness
bestShotPath (optional)
String
URL лучшего кадра в формате PNG
preferredMediaPath (optional)
String
URL медиаконтейнера API
additionalTags (опционально)
String
Дополнительные теги, если требуются (в том числе не из перечисления OzMediaTag)
metaData
Map<String, String>
Метаданные медиафайлам
enum OzMediaTag
Тег в соответствии с жестом на видео.
Значение
Описание
Blank
Видео без определенного жеста
PhotoSelfie
Селфи-фото
VideoSelfieOneShot
Видео с извлекаемым лучшим кадром
VideoSelfieScan
Видео с жестом «сканирование»
VideoSelfieEyes
Видео с жестом «моргание»
VideoSelfieSmile
Видео с жестом «улыбка»
VideoSelfieHigh
Видео с жестом «подъем головы наверх»
VideoSelfieDown
Видео с жестом «наклон головы вниз»
VideoSelfieRight
Видео с жестом «поворот головы направо»
VideoSelfieLeft
Видео с жестом «поворот головы налево»
PhotoIdPortrait
Фото, извлеченное из документа
PhotoIdBack
Фото оборотной стороны документа
PhotoIdFront
Фото лицевой стороны документа
sealed class LicenseSource
Класс для хранения лицензии, может быть:
LicenseAssetId
Содержит идентификатор лицензии.
Параметр
Тип
Описание
id
Int
Идентификатор лицензии
LicenseFilePath
Содержит путь к лицензии.
Параметр
Тип
Описание
path
String
Абсолютный путь к лицензии
class AnalysisStatus
Класс для статуса анализа, может быть:
RunningAnalysis
Статус означает, что анализы запущены.
Параметр
Тип
Описание
analysis
Информация о том, какие анализы и к каким медиафайлам применять.
UploadingMedia
Статус означает, что в настоящее время загружаются медиафайлы.
Параметр
Тип
Описание
media
Объект, который загружается в данный момент
index
Int
Номер объекта в списке
from
Int
Количество объектов
percentage
Int
Процент завершения
enum Type
Тип анализа.
Значение
Описание
BIOMETRY
Позволяет сравнить несколько фото или видео и оценить уровень схожести запечатленных на них людей.
QUALITY
Проверяет наличие живого человека в кадре
DOCUMENTS
Определяет наличие документа в кадре и проверяет корректность полей документа согласно его типу.
В настоящее время для типа DOCUMENTS режим ON_DEVICE не поддерживается.
enum Mode
Режим анализа.
Значение
Описание
ON_DEVICE
Анализ на устройстве
SERVER_BASED
Анализ на сервере
HYBRID
Гибридный анализ для Liveness: если итоговая оценка анализа на устройстве больше определенного порога, медиафайл дополнительно анализируется на сервере
class Analysis
Содержит информацию о том, какие анализы и к каким медиафайлам применять.
Параметр
Тип
Описание
type
Тип анализа
mode
Режим анализа
mediaList
Массив объектов OzAbstractMedia
params (опционально)
Map<String, Any>
Дополнительные параметры
sizeReductionStrategy
Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа
enum Resolution
Сводный статус по выполненным анализам.
Значение
Описание
FAILED
Один или более анализов не удалось завершить из-за ошибок
DECLINED
Проверка не пройдена (лица не совпадают или замечена спуфинг-атака)
SUCCESS
Проверка успешно пройдена
OPERATOR_REQUIRED
Результат анализов должен быть дополнительно перепроверен оператором
class OzAttemptsSettings
Количество попыток выполнения анализов, после которого SDK выдаст ошибку.
Параметр
Тип
Описание
singleCount
Int
Количество попыток для одного действия/жеста
commonCount
Int
Суммарное количество попыток для всех действий/жестов, если используется последовательность (комбо)
enum OzLocalizationCode
Код языка SDK в соответствии с ISO 639-1.
Значение
Описание
EN
Английский
RU
Русский
HY
Армянский
KK
Казахский
KY
Кыргызский
TR
Турецкий
ES
Испанский
PT-BR
Португальский
class OzLogging
Настройки журналирования.
Параметр
Тип
Описание
allowDefaultLogging
Boolean
Включает запись в LogCat
allowFileLogging
Boolean
Включает запись в файл
journalObserver
StatusListener
Обработчик для получения событий на стороне приложения
sealed class Color
Настройки цвета, в зависимости от принимаемого значения могут быть:
ColorRes
Параметр
Тип
Описание
resId
Int
Ссылка на цвет в системе ресурсов Android
ColorHex
Параметр
Тип
Описание
hex
String
Цвет в формате HEX (например #FFFFFF)
ColorInt
Параметр
Тип
Описание
color
Int
Int-значение цвета в Android
enum GeometryType
Форма рамки.
Значение
Описание
Oval
Овал
Rectangle
Прямоугольник
Circle
Круг
Square
Квадрат
class AnalysisError
Класс для описания ошибок.
Параметр
Тип
Описание
apiErrorCode
Int
Код ошибки
message
String
Сообщение
class SourceMedia
Описывает отправленный на анализ медиафайл.
Параметр
Тип
Описание
mediaId
String
Идентификатор медиафайла
mediaType
String
Тип медиа
originalName
String
Первоначальное название файла
ozMedia
Медиафайл
tags
List<String>
Теги файла
class ResultMedia
Описывает результат анализа для одного медиафайла.
Параметр
Тип
Описание
confidenceScore
Float
Итоговая оценка
isOnDevice
Boolean
Режим анализа
resolution
Общий результат анализа
sourceMedia
Анализируемый медиафайл
type
Тип анализа
class RequestResult
Сводный результат анализа для всех медиафайлов.
Параметр
Тип
Описание
analysisResults
Результат анализа
folderId
String
Идентификатор
resolution
Общий результат анализа
class AnalysisResult
Описывает результаты анализов для всех медиафайлов в папке.
Параметр
Тип
Описание
resolution
Общий результат анализа
type
Тип анализа
mode
Режим анализа
resultMedia
Список результатов отдельных анализов
confidenceScore
Float
Итоговая оценка
analysisId
String
Идентификатор анализа
params
@RawValue Map<String, Any>
Дополнительные параметры папки
error
Ошибка
serverRawResponse
String
Ответ сервера
class OzConnection
Определяет метод авторизации.
OzConnection.fromServiceToken
Авторизация по токену.
Параметр
Тип
Описание
host
String
Адрес сервера API
token
String
Токен доступа
OzConnection.fromCredentials
Авторизация по логину и паролю.
Параметр
Тип
Описание
host
String
Адрес сервера API
username
String
Логин
password
String
Пароль
class OzUploadMediaSettings
Настройки повторной отправки медиафайлов.
Параметр
Тип
Описание
attemptsCount
Int
Количество попыток отправки медиафайлов
attemptsTimeout
Int
Интервал времени между попытками
enum SizeReductionStrategy
Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа. По умолчанию отправляется сжатое видео.
Значение
Описание
UPLOAD_ORIGINAL
Исходное видео
UPLOAD_COMPRESSED
Сжатое видео
UPLOAD_BEST_SHOT
Полученный из видео лучший кадр
UPLOAD_NOTHING
Ничего (в этом случае на сервер не отправляется ничего, папка не создается)
Возможные ошибки
Код ошибки
Сообщение
Описание
ERROR = 3
Error.
Неизвестная ошибка
ATTEMPTS_EXHAUSTED_ERROR = 4
Error. Attempts exhausted for liveness action.
VIDEO_RECORD_ERROR = 5
Error by video record.
Ошибка записи видео
NO_ACTIONS_ERROR = 6
Error. OzLivenessSDK started without actions.
FORCE_CLOSED = 7
Error. Liveness activity is force closed from client application.
Клиент закрыл экран Liveness во время работы
DEVICE_HAS_NO_FRONT_CAMERA = 8
Error. Device has not front camera.
Фронтальная камера на устройстве не найдена
DEVICE_HAS_NO_MAIN_CAMERA = 9
Error. Device has not main camera.
Задняя (основная) камера на устройстве не найдена
DEVICE_CAMERA_CONFIGURATION_NOT_SUPPORTED = 10
Error. Device camera configuration is not supported.
Liveness не поддерживает конфигурацию камеры на устройстве
FACE_ALIGNMENT_TIMEOUT = 12
Error. Face alignment timeout in OzLivenessSDK.config.faceAlignmentTimeout milliseconds
Время подготовки, выделенное на съемку, истекло
ERROR = 13
The check was interrupted by user
Пользователь закрыл экран Liveness во время проверки
Last updated