Skip to content

chore: Add VideoOptions docs for Liveness on Android #6817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mattcreaser wants to merge 2 commits into
base: main
Choose a base branch
from
+36 −1
Open

chore: Add VideoOptions docs for Liveness on Android #6817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94a3a1a
Add section on the videoOptions to Liveness for Android
mattcreaser Jan 23, 2026
b2a3d86
Update Liveness version for Android
mattcreaser Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/src/pages/[platform]/connected-components/liveness/android-props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ export const FACE_LIVENESS_DETECTOR_PARAMETERS = [
'Optional parameter that allows you to configure options for a given liveness challenge.',
type: `ChallengeOptions`,
},
{
name: 'videoOptions',
description:
'Optional parameter that allows you to configure options for the video stream in the liveness session.',
type: 'VideoOptions',
},
{
name: `onComplete`,
description:
Expand Down
29 changes: 29 additions & 0 deletions ...]/connected-components/liveness/customization/customization.options.android.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
import { Alert } from '@aws-amplify/ui-react';
import ReactPropsTable from '@/components/propsTable/ReactPropsTable';

export const VIDEO_OPTIONS = [
{
name: `videoCodec`,
description: 'The codec to use for encoding the video stream. Options are VP8, VP9, and H264. The default is VP8.',
type: `VideoCodec`,
},
];

## Challenge Options

Expand All @@ -23,3 +32,23 @@ FaceLivenessDetector(
<Alert variation="info" role="none">
When the FaceLivenessDetector is rendered, Rekognition will mark the session ID as used and any future usages of the FaceLivenessDector will require a new session ID. So if you want to change which camera is used for the FaceMovement challenge at runtime, you will need to create a new liveness session and pass the new session ID into the FaceLivenessDetector with the new Camera option.
</Alert>

## Video Options

Video options allow you to configure the video stream used during a liveness session. The following options are available:

<ReactPropsTable props={VIDEO_OPTIONS} />

```kotlin
FaceLivenessDetector(
sessionId = <session ID>,
region = <region>,
videoOptions = VideoOptions(videoCodec = VideoCodec.H264),
onComplete = {
Log.i("MyApp", "Face Liveness flow is complete")
},
onError = { error ->
Log.e("MyApp", "Error during Face Liveness flow", error)
}
)
```
2 changes: 1 addition & 1 deletion .../src/pages/[platform]/connected-components/liveness/quick-start-add.android.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Add the following dependencies to your **app**'s `build.gradle` file and click "
```groovy
dependencies {
// FaceLivenessDetector dependency
implementation 'com.amplifyframework.ui:liveness:1.5.0'
implementation 'com.amplifyframework.ui:liveness:1.9.0'

// Amplify Auth dependency (unnecessary if using your own credentials provider)
implementation 'com.amplifyframework:aws-auth-cognito:2.29.0'
Expand Down
Loading