Videollamada

Introducción

La captura facial se realiza con el VideoCall Component.

Este componente se encarga de gestionar la comunicación entre un usuario y un agente (videoasistencia). Sus principales procesos son:

  • Gestión interna de cámaras, micro y permisos.

  • Conexión con los servicios.

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

  • Las dependencias obligatorias que deberán haberse instalado previamente (añadiéndolas en el fichero Podfile del proyecto) son:

pod 'FPHISDKMainComponent', '~> 2.3.0'
  • Para instalar el componente de Videollamada deberá incluirse la siguiente entrada en el Podfile de la aplicación:

pod 'FPHISDKVideoCallComponent', '~> 2.3.0'

SPM

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

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

Controladores disponibles

Controlador

Descripción

VideoCallController

Controlador principal de videollamada

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.

Lanzamiento:

Configuración básica

La configuración básica necesaria no necesitará ningún parámetro.

Recepción del resultado

Los controllers devolverán la información necesaria en formato SdkResult.

Recepción de errores

En la parte del error, dispondremos de la clase común ErrorType.

  • VCL_CANCEL_BY_USER: El usuario ha cancelado el proceso

  • VCL_CANCEL_LAUNCH: Se ha hecho una cancelación general del SDK

  • VCL_COMPONENT_LICENSE_ERROR: La licencia del componente no es correcta

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

  • VCL_FACE_DETECTION_TIMEOUT: No se ha detectado cara

  • VCL_INITIALIZATION_ERROR: Error de inicialización

  • VCL_MANAGER_NOT_INITIALIZED: Los managers son nulos

  • VCL_NETWORK_CONNECTION: Error en la conexión a internet

  • VCL_NO_DATA_ERROR: Los datos de entrada son nulos

  • VCL_OPERATION_NOT_CREATED: No hay ninguna operación en curso

  • VCL_PERMISSION_DENIED: El usuario ha rechazado los permisos

  • VCL_SOCKET_ERROR: Error en la conexiónde los servicios

  • VCL_TIMEOUT: Timeout en el proceso

  • VCL_VIDEO_ERROR: Error en el procesamiento del vídeo

  • VCL_UNKNOWN_ERROR: Error desconocido

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

Recepción de ejecución correcta - data

En la ejecución correcta, simplemente se informa de que todo ha ido bien con el SdkResult.Success.

Cuando el resultado sea Success y esté activo el flag sharingScreen se podrá activar compartir pantalla.

Información avanzada

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

Configuración avanzada del componente

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.

activateScreenSharing

Activar la opción de compartir pantalla en la llamada.

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.

vibrationEnabled

Si se le da valor true, se activa la vibración en errores y si la respuesta del widget es OK

Personalización del componente

Aparte de los cambios que se pueden realizar a nivel de SDK (los cuales se explican en el documento de Personalización del SDK), este componente en concreto permite la modificación de su interfaz.

Textos

Los textos pueden ser customizados sobreescribiendo el valor de las siguientes claves en un Localizable.strings. Las claves que contienen el sufijo _alt son los literales utilizados en las etiquetas de accesibilidad necesarias para la funcionalidad de voice over.

Name

Value

video_call_component_exit_alert_question

¿Seguro que quieres finalizar la llamada?

video_call_component_exit_alert_finish

Finalizar

video_call_component_exit_alert_accept

Aceptar

video_call_component_exit_alert_cancel

Cancelar

video_call_component_skip

OMITIR

video_call_component_restart

REINTENTAR

video_call_component_agent

Asistente

video_call_component_text_waiting_agent_title

Conectando con un asistente...

video_call_component_close_button_alt

Cerrar

video_call_component_back_button_alt

Atrás

video_call_component_timeout_title

Tiempo superado

video_call_component_timeout_desc

No se ha podido conectar con un agente.

De este modo, si se desea modificar por ejemplo el texto “Finalizar” de la clave video_call_component_exit_alert_finish para el idioma es-MX, se deberá ir al archivo Localizable.strings de la carpeta es-MX.lproj si es que existe (si no, se deberá crear) y ahí, añadir:

"video_call_component_exit_alert_finish"="Terminar";

Si un mensaje no se especifica en el fichero del idioma, este se rellenará con el mensaje por defecto.

Colores

Los colores se inicializan similarmente en la variable colors con un diccionario, teniendo como valor un UIColor que se desee.

Animaciones

Las animaciones a usar se inicializan similarmente en la variable animations con un diccionario, teniendo como valor una string con el nombre de la animación que se encuentre en xcassets que se desee usar.

Last updated