> 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/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/capacitor/componentes/captura-facial.md).

# Captura facial - Selphi

## Introdução <a href="#id-1-introduccion" id="id-1-introduccion"></a>

A Captura Facial é realizada com o ***Selphi Plugin***.

Este componente é responsável por realizar a captura de uma selfie do usuário e pela posterior extração das características faciais mais importantes. Seus principais processos são:

* Gestão interna de câmeras e permissões.
* Assistente nos processos de captura do rosto do usuário.
* Geração dos modelos com as características faciais e da imagem do usuário.

***

## Dependências <a href="#id-2-dependencia" id="id-2-dependencia"></a>

### Capacitor:

```bash
npm install @facephi/sdk-selphi-capacitor@<versão>
npm run build
npx cap sync
```

### Android - Gradle:

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

### iOS - CocoaPods:

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

## Métodos disponíveis

Este componente contém vários métodos que executam diferentes funcionalidades:

<table data-header-hidden><thead><tr><th width="233.64453125"></th><th></th></tr></thead><tbody><tr><td><strong>Método</strong></td><td><strong>Descrição</strong></td></tr><tr><td>startExtraction</td><td>Controlador principal de Reconhecimento Facial</td></tr></tbody></table>

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

Uma vez iniciado o SDK e criada uma nova operação, será possível lançar o componente. Será possível fazer uso de qualquer um de seus controladores para executar sua funcionalidade.

Lançamento da Captura Facial:

```typescript
startExtraction(configuration: SelphiFaceConfiguration): Promise<SelphiFaceResult>;
```

## Configuração básica <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

Para iniciar o componente atual, deverá ser criado um objeto ***SelphiFaceConfiguration*** que será a configuração do controlador do componente.

A configuração básica necessária é a seguinte:

```typescript
export interface SelphiFaceConfiguration {
  debug?: boolean;
  fullscreen?: boolean;
  cropPercent?: number;
  stabilizationMode?: boolean;
  templateRawOptimized?: boolean;
  resourcesPath?: string;
  enableGenerateTemplateRaw?: boolean;
  livenessMode?: SdkLivenessMode;
  showResultAfterCapture?: boolean;
  cameraFlashEnabled?: boolean;
  translationsContent?: string;
  viewsContent?: string;
  showTutorial?: boolean;
  cameraId?: number;
  videoFilename?: string;
  params?: any;
  qrMode?: boolean;
  showDiagnostic?: boolean;
  logImages?: boolean;
  compressFormat?: SdkCompressFormat;
  jpgQuality?: number;
  showPreviousTip?: boolean;
  vibrationEnabled?: boolean;
  extractionDuration?: SdkExtractionDuration;
  cameraPreferred?: SelphiCamera;
  moveSuccessfulAttempts?: number;
  moveFailedAttempts?: number;
}
```

### Configuração avançada do componente

A seguir, estão detalhados todos os campos que fazem parte desta classe.

{% content-ref url="/pages/0afd89828298c2fc4a7b07f4629e3404a8fc7478" %}
[Configuração do Selphi](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/selphi/selphi-configuracion.md)
{% endcontent-ref %}

***

## Recebimento do resultado <a href="#id-6-recepcion-del-resultado" id="id-6-recepcion-del-resultado"></a>

O lançamento retornará as informações no formato SelphiFaceResult. Podendo diferenciar-se entre um lançamento correto e um incorreto:

```typescript
export interface SelphiFaceResult {
  finishStatus?: number;
  errorType?: string;
  finishStatusDescription?: string;
  errorMessage?: string;
  bestImage?: string;
  bestImageCropped?: string;
  bestImageTemplateRaw?: string;
  qrData?: string;
  templateRaw?: string;
  images?: string[];
  livenessDiagnostic?: string;
}
```

{% content-ref url="/pages/3b5c683e38ec249191af062aa2c57157010c3a75" %}
[Selphi Resultado](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/selphi/selphi-resultado.md)
{% endcontent-ref %}

## Personalização do componente <a href="#id-8-personalizacion-del-componente" id="id-8-personalizacion-del-componente"></a>

Além das alterações que podem ser feitas no nível do SDK (as quais são explicadas no documento de [Configurações avançadas](#id-1-introduccion))

{% content-ref url="/pages/aff192aab37b89a77b973328bef3062aaa53696a" %}
[Selphi - Personalização do Componente](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/selphi/selphi-personalizacion-del-componente.md)
{% endcontent-ref %}