Voice Component

1. Introducción

El Componente tratado en el documento actual recibe el nombre de Voice Component. Éste se encarga de realizar la captura de voz del usuario y la posterior extracción de las plantillas correspondientes. Sus principales funcionalidades son las siguientes:

• Entrada de cierto número de frases para posteriormente leer cada una en un paso.
• Gestión interna del micrófono.
• Gestión de permisos.
• Análisis de los silencios.
• Análisis del progreso.
• Asistente en los procesos de captura.
• Generación de las plantillas con las características de la voz y puntuaciones.

1.1 Requisitos mínimos

La versión mínima nativa (Android y iOS) de la SDK son las siguientes:

• Versión mínima Android: 24 - JDK 17
• Versión mínima Build Tools: 8.1.4
• Versión mínima Kotlin Android: 1.9.0
• Versión mínima iOS: 13
• Versión mínima Flutter: 3.0

En cuanto a la arquitectura del dispositivo móvil:

armeabi-v7, x86, arm64 y x64

1.2 Versión del plugin

La versión del plugin actual se puede consultar de la siguiente forma:

Buscamos el archivo pubspec.yaml en la raíz del plugin.

En el KEY/TAG version se indica la versión.

2. Integración del componente

Antes de integrar este componente se recomienda leer la documentación relativa a Core Component y seguir las instrucciones indicadas en dicho documento.

ℹ️ En esta sección se explicará paso a paso cómo integrar el componente actual en un proyecto ya existente. Para esta sección, se considerarán los siguiente valores:

• <%APPLICATION_PATH%> - Path a la raíz de la aplicación (ejemplo: /folder/example)
• <%PLUGIN_CORE_PATH%> - Path a la raíz del plugin core, que es obligatorio (ejemplo: /folder/sdk-core)
• <%PLUGIN_VOICE_PATH%> - Path a la raíz del plugin actual (ejemplo: /folder/sdk-voice)

2.1. Instalación del plugin: Common

El plugin permite la ejecución en platafoma Android y iOS. En esta sección se explican los pasos comunes. Para instalar el plugin se deben seguir los siguientes pasos:

• Asegurarse de que Flutter esté instalado.
• Acceda al APPLICATION_PATH en un terminal y ejecute:

dart pub token add "https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi"

• Acceda al <%APPLICATION_PATH%>, y en el fichero pubspec.yaml y añadir:

fphi_sdkmobile_voice:
  hosted:
    name: sdkvoice
    url: https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi/
  version: ^2.0.0

Después de ejecutar los pasos anteriores, puede iniciar la aplicación con el sdk/componente instalado. Desde diferentes IDE's, los proyectos generados en las carpetas de Android e iOS se pueden abrir, compilar y depurar usando Android Studio y XCode respectivamente.

2.2 Instalación plugin: iOS

2.2.1 Configuración del proyecto

Para la versión de iOS, a la hora de añadir nuestro plugin a la aplicación final, previamente se deben tener en cuenta los siguientes puntos:

• Añadir los permisos de cámara: Para utilizar el widget, es necesario habilitar el permiso de la cámara en el archivo info.plist de la aplicación (incluido dentro del proyecto en la carpeta ios). Se deberá editar el archivo con un editor de texto y agregar el siguiente par clave/valor:

<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) uses the camera</string>

2.2.2 Actualizar el Podfile

En el podfile del proyecto será necesario añadir la información del repositorio privado (ver apartado 2.1). Para ello, se deberá agregar las siguientes lineas al inicio del fichero:

platform :ios, '13.0' //MIN VERSION
plugin 'cocoapods-art', :sources => ['cocoa-pro-fphi']
source 'https://cdn.cocoapods.org/'

ℹ️ Para saber más acerca de la configuración y uso de Cocoapods Artifactory, es necesario acceder al siguiente documento de Componente Core.

2.2.4 Posibles incidencias

Si ocurren problemas de entorno o no se actualiza el plugin tras realizar nuevos cambios (por ejemplo, problemas ocurridos debido a que no se genera correctamente el bundle, o no se actualizan las librerías a las versiones adecuadas), se recomienda ejecutar la siguiente secuencia de instrucciones tras lanzar el plugin:

• Abrir la carpeta ios de la aplicación en un terminal.
• Ejecutar el siguiente comando:

pod deintegrate

• Eliminar el Podfile.lock
• Ejecutar el siguiente comando (o abrir el proyecto con Xcode y ejecutarlo):

pod repo-art update cocoa-pro-fphi
pod install --repo-update

2.3 Instalación plugin: Android

2.3.1 Establecer la versión de Android SDK

En el caso de Android, la versión mínima de SDK requerida por nuestras bibliotecas nativas es 24, por lo que si la aplicación tiene un SDK mínimo definido menor que éste, deberá modificarse para evitar un error de compilación. Para ello accede al fichero build.gradle de la aplicación (ubicado en la carpeta android) y modifica el siguiente parámetro:

buildscript {
  ext {
    minSdkVersion = 24
  }
}

---

3. Configuración del componente

El componente actual contiene una serie de métodos e interfaces de dart incluidos dentro del archivo fphi_sdkmobile_voice_configuration.dart. En este fichero se puede encontrar la API necesaria para la comunicación entre la aplicación y la funcionalidad nativa del componente. A continuación, se explica para qué sirve cada uno de los enumerados y las demás propiedades que afectan al funcionamiento del componente.

A continuación se muestra la clase VoiceConfiguration, que permite configurar el componente de Voice:

class VoiceConfiguration
{
  String mPhrases;
  int? mTimeout;
  bool? mShowDiagnostic;
  bool? mShowTutorial;
  bool? mVibrationEnabled;
  bool? mReturnAudios;
  bool? mReturnTokenizedAudios;
}

A continuación, se comentarán todas las propiedades que se pueden definir en el objeto VoiceConfiguration:

ℹ️ Toda la configuración se podrá encontrar en el archivo fphi_sdkmobile_voice/fphi_sdkmobile_voice_configuration.dart. del componente.

A la hora de realizar la llamada al widget existe una serie de parámetros que se deben incluir. A continuación se comentarán brevemente.

3.1 phrases

type: string

Indica la(s) frase(s) requerida(s) para capturar. Si se utiliza más de una frase, estará separada por el símbolo de barra vertical (|).

phrases: 'hola mundo|hola voice component|hola Facephi',

3.2 timeout

type: number

Se setea el timeout del plugin.

timeout: 10000;

3.3 showTutorial

type: boolean

Indica si se desea mostrar el tutorial completo del proceso o sólo la versión simplificada.

showTutorial: true;

3.4 vibration

type: boolean

Indica si se desea o no habilitar la vibración del plugin.

3.5 showDiagnostic

type: boolean

Indica si se desea o no mostrar la pantalla de errores del plugin.

3.6 returnAudios

type: boolean

Indica si se desea o no retornar los audios grabados al final del proceso.

returnAudios: false;

3.7 returnTokenizedAudios

type: boolean

Indica si se desea o no retornar los audios tokenizados grabados al final del proceso.

returnTokenizedAudios: false;

---

4. Uso del componente

A continuación se mostrará la manera de ejecutar la funcionalidad del componente actual.

⚠️ Se recuerda que para lanzar un componente determinado previamente habrá que inicializar el SDK con su respectiva licencia, y después iniciar una nueva operación. Para más información consulte la documentación del Componente Core.

Una vez configurado el componente, para lanzarlo se deberá ejecutar el siguiente código:

Future<Either<Exception, VoiceResult>> launchVoice() async {
  return launchVoiceWithConfiguration(createStandardConfiguration());
}

Future<Either<Exception, VoiceResult>> launchVoiceWithConfiguration(VoiceConfiguration configuration) async {
  try
  {
    FphiSdkmobileVoice voice = FphiSdkmobileVoice();
    final Map resultJson = await voice.startVoiceComponent(widgetConfigurationJSON: configuration);

    return Right(VoiceResult.fromMap(resultJson));
  }
  on Exception catch (e) {
    return (Left(e));
  }
}

/// Sample of standard plugin configuration
VoiceConfiguration createStandardConfiguration()
{
  VoiceConfiguration configurationWidget;
  configurationWidget = VoiceConfiguration();
  configurationWidget.mVibrationEnabled = true;
  configurationWidget.mShowTutorial     = true;
  configurationWidget.mPhrases          = "Hola hello world|Chau voice component|Hola voice component";

  return configurationWidget;
}

---

5. Retorno de resultado

Como se muestra en el ejemplo anterior, el resultado se devuelve en forma de objeto JSON a través de Promises, ya sea una operación exitosa o un error:

FphiSdkmobileVoice voice = FphiSdkmobileVoice();
final Map resultJson = await voice.startVoiceComponent(widgetConfigurationJSON: configuration);

return Right(VoiceResult.fromMap(resultJson));

Independientemente de si el resultado es correcto/erróneo el resultado tendrá el siguiente formato:

class VoiceResult
{
  final SdkFinishStatus finishStatus;
  final String finishStatusDescription;
  final String errorDiagnostic;
  final String? errorMessage;
  final dinamic audios;
  final dinamic tokenizedAudios;
}

ℹ️ El resultado será devuelto por medio de una Promise que contiene un objeto de la clase VoiceResult. A continuación se amplía información sobre esos campos.

5.0 finishStatus

• 1: La operación fue exitosa.
• 2: Se ha producido un error, el cuál se indicará en el string errorDiagnostic y, opcionalmente, se mostrará un mensaje de información extra en la propiedad errorMessage.

5.1 finishStatusDescription

• STATUS_OK: La operación fue exitosa.
• STATUS_ERROR: Se ha producido un error, el cuál se indicará en el string errorDiagnostic y, opcionalmente, se mostrará un mensaje de información extra en la propiedad errorMessage.

5.2 errorDiagnostic

Devuelve el tipo de error que se ha producido (en el caso de que haya habido uno, lo cual se indica en el parámetro finishStatus con el valor Error). Los valores que puede tener son los siguientes:

• NoError: No ha ocurrido ningún error. El proceso puede continuar.
• UnknownError: Error no gestionado. Posiblemente causado por un error en el bundle de recursos.
• CameraPermissionDenied: Excepción que se produce cuando el sdk no tiene permiso de acceso a la cámara.
• SettingsPermissionDenied: Excepción que se produce cuando el widget no tiene permiso de acceso a la configuración del sistema (deprecated).
• HardwareError: Excepción que surge cuando existe algún problema de hardware del dispositivo, normalmente causado porque los recursos disponibles son muy escasos.
• ExtractionLicenseError: Excepción que ocurre cuando ha habido un problema de licencias en el servidor.
• UnexpectedCaptureError: Excepción que ocurre durante la captura de frames por parte de la cámara.
• ControlNotInitializedError: El configurador del widget no ha sido inicializado.
• BadExtractorConfiguration: Problema surgido durante la configuración del widget.
• CancelByUser: Excepción que se produce cuando el usuario para la extracción de forma manual.
• TimeOut: Excepción que se produce cuando transcurre un tiempo máximo sin conseguir finalizar la extracción con éxito.
• InitProccessError: Excepción que se produce cuando el sdk no puede procesar las imagenes capturadas.
• NfcError: Excepción que se produce cuando el sdk no tiene permiso de acceso al nfc.
• NetworkConnection: Excepción que se produce cuando hay inconvenientes con los medios que usa el dispositivo para conectarse a la red.
• TokenError: Excepción que se produce cuando se pasa por parámetro un token no válido.
• InitSessionError: Excepción que se produce cuando no se puede inicializar session. Lo normal es que ocurra porque no se llamo al SdkCore al ppio de llamar a cualquier otro componente.
• ComponentControllerError: Excepción que se produce cuando no se puede instanciar el componente.

5.3 errorMessage:

Indica un mensaje de error adicional en caso de ser necesario. Es un valor opcional.

5.5 audios:

Devuelve los audios grabados. Sólo si el parámetro returnAudios se estableció en verdadero.

5.6 tokenizedAudios

Devuelve los audios grabados tokenizados. Sólo si el parámetro returnTokenizedAudios se estableció en verdadero.