Vídeo grabación

Introducción

El Componente tratado en el documento actual recibe el nombre de VideoRecording Component. Éste se encarga de capturar la pantalla del dispositivo en segundo plano. Está orientado principalmente para la grabación del proceso de onboarding.

En el apartado de Lanzamiento simplificado se detallan los pasos necesarios para la integración básica del SDK. En esta sección se añade la información para el lanzamiento de este componente.

Dependencias

Para evitar conflictos y problemas de compatibilidad, en caso de querer instalar el componente en un proyecto que contenga una versión antigua de las librerías de Facephi (Widgets), éstos deberán eliminarse por completo antes de la instalación de los componentes de la SDKMobile.

Cocoapods

• Actualmente las librerías de FacePhi se distribuyen de forma remota a través de diferentes gestores de dependencias, en este caso Cocoapods. Las dependencias obligatorias que deberán haberse instalado previamente (añadiéndolas en el fichero Podfile del proyecto) son:

  pod 'FPHISDKMainComponent', '~> 2.3.0'
  pod 'zipzap'

• Para instalar el componente de Selphi deberá incluirse la siguiente entrada en el Podfile de la aplicación:

  pod 'FPHISDKVideoRecordingComponent', '~> 2.3.0'

SPM

• Las dependencias obligatorias que deberán haberse instalado previamente son:

//HTTPS
https://github.com/facephi-clienters/SDK-SdkPackage-SPM.git
//SSH
[email protected]:facephi-clienters/SDK-SdkPackage-SPM.git

• Para instalar el componente de SELPHI deberá incluirse en los módulos del proyecto:

//HTTPS
https://github.com/facephi-clienters/SDK-VideoRecording-SPM.git
//SSH
[email protected]:facephi-clienters/SDK-VideoRecording-SPM.git

Controladores disponibles

Controlador	Descripcion
VideoRecordingController	Controlador principal de Videograbación

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.

Declaración de controlador

private var videoRecordingController: VideoRecordingController?

Lanzamiento de la captura

Para iniciar la grabación de pantalla:

public func launchVideoRecording(viewController: UIViewController) {
    let data = VideoRecordingConfigurationData()
    let videoRecordingController = VideoRecordingController(data: data, extensionIdentifier: "com.facephi.sdk.demo.videoRecording", viewController: viewController, output: {
        print("videoRecordingController output: \($0.errorType)")
    })
        
    SDKController.shared.launch(controller: videoRecordingController)
    self.videoRecordingController = videoRecordingController
}

Detener la captura

Para detener la grabación de pantalla:

public func stopVideoRecording() {
    self.videoRecordingController?.stopVideoRecording()
}

Recepción de errores

Los errores se devolverán como un objeto 'VideoRecordingError'.

Lista de errores:

• VRC_EMPTY_LICENSE: El String de licencia está vacío

• VRC_INITIALIZATION_ERROR: Error de inicialización

• VRC_OPERATION_NOT_CREATED: No hay ninguna operación en curso

• VRC_NETWORK_CONNECTION: Error en la conexión a internet

• VRC_PERMISSION_ERROR: El usuario ha rechazado los permisos

• VRC_SOCKET_ERROR: Error en la conexión de los servicios

• VRC_UNKNOWN_ERROR: Error desconocido

• VRC_VIDEO_CALL_ACTIVE: No se puede iniciar porque hay una videollamada activa

• VRC_VIDEO_ERROR: Error en el procesamiento del vídeo

• VRC_VIDEO_RECORDING_ACTIVE: No se puede iniciar porque el proceso de grabación de vídeo está activo

Información avanzada

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

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.

url

Ruta al socket de video

apiKey

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

tenantId

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