> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/sdks/sdk-mobile/framework-plugins/flutter/componentes/video-id.md).

# Videoidentificación - VideoID

* Gestión interna de cámaras, micro y permisos.
* Conexión con los servicios.
* Lectura del OCR y captura del documento.

## Dependencias <a href="#id-2-dependencia" id="id-2-dependencia"></a>

### Flutter:

```swift
dependencies:
  fphi_sdkmobile_videoid:
    hosted:
      name: fphi_sdkmobile_videoid
      url: https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi/
    version: ^<versión>
```

### Android - Gradle:

```kotlin
implementation "com.facephi.androidsdk:videoid_component:$version"
```

### iOS - Cocoapods:

```swift
s.dependency 'FPHISDKVideoIDomponent', '~> $version'
```

## Método startVideoIdComponent <a href="#id-4-lanzamiento-simplificado" id="id-4-lanzamiento-simplificado"></a>

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 del Componente:

```dart
Future<Map> startVideoIdComponent({required VideoIdConfiguration widgetConfigurationJSON})
{
  return FphiSdkmobileVideoidPlatform.instance.startVideoIdComponent(
      widgetConfigurationJSON: widgetConfigurationJSON
  );
}
```

## Configuración básica <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

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

La configuración básica necesaria para es la siguiente:

```dart
class VideoIdConfiguration
{
  PreferredCamera mPreferredCamera;
  VideoMode mMode;
  String? mUrl;
  String? mApiKey;
  String? mTenantId;
  String? mSpeechText;
  List<String>? mDocumentFilter;
  List<String>? mCountryFilter;
  bool mShowTutorial;
  bool? mShowDiagnostic;
  bool? mAutoFaceDetection;
  bool? mDebug;
  bool? mVibrationEnabled;
  int mSectionTime;
  int? mSectionTimeout;
  int? mTimeoutServerConnection;
  int? mTimeoutFaceDetection;
  int? mMaxRetries;
}
```

{% content-ref url="/pages/j2wTykQlqC8THAglzP3Z" %}
[Video Id Configuración](/sdks/sdk-mobile/framework-plugins/extras/video-id/video-id-configuracion.md)
{% endcontent-ref %}

### Configuración avanzada del componente

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

## Recepción del resultado <a href="#id-6-recepcion-del-resultado" id="id-6-recepcion-del-resultado"></a>

El lanzamiento devolverá la información en formato ***VideoIdResult***. Pudiendo diferenciarse entre un lanzamiento correcto y uno incorrecto:

```dart
class VideoIdResult
{
  final SdkFinishStatus finishStatus;
  final String finishStatusDescription;
  final String errorDiagnostic;
  final String? errorMessage;
  final dynamic ocrMap;
  final String? faceImage;
  final String? faceImageTokenized;
  final double? matchingSidesScore;
  final String? speechText;
  final String? documentType;
  final dynamic personalData;
  final dynamic frontDocumentData;
  final dynamic backDocumentData;
  final dynamic ocrDiagnostic;
}
```

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

{% content-ref url="/pages/1nJjjGavGWsAq6dpXyWL" %}
[Video Id Resultado](/sdks/sdk-mobile/framework-plugins/extras/video-id/video-id-resultado.md)
{% endcontent-ref %}