Saltar al contenido principal
Version: SNAPSHOT 🚧

Vídeo grabación

1. Introducción​

La captura de documentos se realiza con el VideoRecording Component.

Este componente se encarga de capturar la pantalla del dispositivo en segundo plano. Está orientado principalmente para la grabación del proceso de onboarding.

2. Dependencia​

La dependencia específica del componente es:

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

3. Controladores disponibles​

ControladorDescripción
VideoRecordingControllerControlador principal de video grabación.
StopVideoRecordingControllerControlador para realizar la parada de la video grabación.

4. Lanzamiento simplificado​

Una vez iniciado el SDK y creada una nueva operación se podrá lanzar el componente. Se podrá hacer uso de cualquiera de sus controladores para ejecutar su funcionalidad.

4.1. Lanzamiento de la captura​

val controller = VideoRecordingController(
    VideoRecordingConfigurationData()
    )

controller.setOutput {
    Napier.d("APP: VIDEO RECORDING STATE (start): ${it.name}")
}

SDKController.launch(controller)

4.1. Detener la captura​

val controller = StopVideoRecordingController()

controller.setOutput {
    Napier.d("APP: VIDEO RECORDING STATE (stop): ${it.name}")
}

SDKController.launch(controller)

4.1. Recepción de los estados​

La evolución del proceso vendrá indicada a través de los estados:

Los controladores de grabación devolverán estados para indicar la evolución del proceso:

AGENT_HANGUP,
FINISH,
SHARING,
LICENSE_ERROR,
INITIALIZATION_ERROR,
OPERATION_NOT_CREATED,
VIDEO_RECORDING_ACTIVE_ERROR,
VIDEO_CALL_ACTIVE_ERROR,
NETWORK_CONNECTION_ERROR,
PERMISSION_ERROR,
CANCEL_BY_USER,
VIDEO_ERROR,
SOCKET_ERROR,
UNKNOWN_ERROR,

Donde SHARING indica que se está grabando la pantalla y FINISH que ha finalizado el proceso.

5. Información avanzada​

Este apartado amplía la información del componente.

5.1. Configuración avanzada del componente​

Para lanzar el componente actual, se deberá crear un objeto VideoRecordingConfigurationData que será la configuración del controlador del componente.

A continuación se detallan todos los campos que forman parte de esta clase.

Los campos incluidos en la configuración, normalmente no es necesario que sean informados ya que se completan internamente a través de la licencia usada.

Estos campos suelen informarse solo cuando el servidor es OnPremise.

5.1.1. url​

Ruta al socket de video

5.1.2. apiKey​

ApiKey necesaria para la conexión con el socket de video

5.1.3. tenantId​

Identificador del tenant que hace referencia al cliente actual, necesario para la conexión con el servicio de video.

8. Logs​

Para visualizar en consola los logs de este componente se podrá usar el filtro: "VIDEO_RECORDING:"