Video Recording

Introduction

Screen video recording is performed with the VideoRecording Component.

This component is responsible for capturing the device screen in the background. It is mainly oriented toward recording the Onboarding process.

---

Dependency

The specific component dependency is:

implementation "com.facephi.androidsdk:video_recording_component:$version"

---

Available controllers

Controller	Description
FVideoRecordingController	Main video recording controller.
FStopVideoRecordingController	Controller to stop video recording.

Error handling

Errors will be returned as a 'VideoRecordingError' object.

List of errors:

List of video recording errors:

• VRC_CANCEL_BY_USER: The user has canceled the process

• VRC_COMPONENT_LICENSE_ERROR: The component License is not valid

• VRC_EMPTY_LICENSE: The License string is empty

• VRC_INITIALIZATION_ERROR: Initialization error

• VRC_OPERATION_NOT_CREATED: There is no operation in progress

• VRC_NETWORK_CONNECTION: Internet connection error

• VRC_PERMISSION_ERROR: The user has denied the necessary permissions. With enableAudio=true it also covers the denial or dismissal of microphone permission and the denial of the permission of MediaProjection.

• VRC_SOCKET_ERROR: Error in the services connection

• VRC_UNKNOWN_ERROR: Unknown error

• VRC_VIDEO_CALL_ACTIVE: Cannot start because there is an active Video Call

• VRC_VIDEO_ERROR: Error in video processing

• VRC_VIDEO_RECORDING_ACTIVE: Cannot start because the video recording process is active

• VRC_FETCH_DATA_ERROR: Error in the result retrieval

Advanced configuration

The controller uses VideoRecordingConfigurationData to configure the connection to the video service and the recording behavior:

• url: Path to the video socket. It is normally obtained from the License, except in On-Premise environments.

• apiKey: Key required for the connection to the video socket.

• tenantId: Identifier of the client tenant.

• enableAudio: Enables audio capture during screen recording. By default false. If provided as true, Android requests RECORD_AUDIO before the MediaProjection; if the user denies or dismisses the permission, the component returns VRC_PERMISSION_ERROR.

Receiving the successful result - data

In case of success, data contains a VideoRecordingResult.

• state: Recording status. SHARING indicates that the recording has started and FINISH indicates that it has been stopped successfully.