> 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/android-sdk/componentes-modulos/captura-de-voz.md).

# Captura de voz - VoiceID

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

A captura de voz é realizada com o ***Voice Component***.

Este componente é responsável por realizar a captura de voz do usuário e a extração posterior dos modelos correspondentes. Seus principais processos são:

* Gerenciamento interno do microfone e das permissões.
* Entrada de um determinado número de frases para que, em seguida, cada uma seja lida em uma etapa.
* Análise dos silêncios.
* Análise do progresso.
* Assistente nos processos de captura.
* Geração dos modelos com as características da voz e as pontuações.

Na seção [Lançamento simplificado](https://docs.facephi.com/docs.facephi-pt-br/sdks/sdk-mobile/android-sdk/inicializacion/lanzamiento-simplificado.md) são detalhadas as etapas necessárias para a integração básica do SDK. Nesta seção, são acrescentadas as informações para o lançamento deste componente.

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

A dependência específica do componente é:

```
implementation "com.facephi.androidsdk:voice_component:$version"
```

## Controladores disponíveis <a href="#id-3-controladores-disponibles" id="id-3-controladores-disponibles"></a>

<table data-header-hidden><thead><tr><th width="193.87109375"></th><th></th></tr></thead><tbody><tr><td><strong>Controlador</strong></td><td><strong>Descrição</strong></td></tr><tr><td>VoiceController</td><td>Controlador principal de captura de voz</td></tr></tbody></table>

\
Lançamento simplificado
-----------------------

Depois que o SDK for iniciado e uma nova operação for criada, será possível iniciar o componente. Você poderá usar qualquer um de seus controladores para executar sua funcionalidade.

Lançamento da captura:

```kotlin
val response = SDKController.launch(
    VoiceController(VoiceConfigurationData(...))
)
when (response) {
    is SdkResult.Error -> Napier.d("ERROR - ${response.error.name}")
    is SdkResult.Success -> response.data
}
```

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

Para iniciar o componente atual, será necessário criar um objeto *VoiceConfigurationData* que será a configuração do controlador do componente.

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

```kotlin
VoiceConfigurationData(
  phrases = arrayOf(
            "Tu nombre complet y tu dirección",
            "Tu número de documento con letra",
        )
)
```

É possível editar a lista de frases que serão exibidas ao usuário.

## 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 SdkResult, permitindo diferenciar entre um lançamento bem-sucedido e um malsucedido:

```
when (response) {
    is SdkResult.Error -> Napier.d("ERROR - ${response.error}")
    is SdkResult.Success -> response.data
}
```

### Recebimento de erros <a href="#id-61-recepcion-de-errores" id="id-61-recepcion-de-errores"></a>

Os erros serão retornados como um objeto 'VoiceError'.

Lista de erros:

* `ACTIVITY_RESULT_MSG_ERROR` (`VOC_502`): O resultado da atividade está incorreto
* `APPLICATION_CONTEXT_ERROR` (`VOC_503`): O contexto de aplicativo necessário é nulo
* `CANCEL_BY_USER` (`VOC_000`): O usuário cancelou o processo
* `CANCEL_LAUNCH` (`VOC_007`): Foi realizado um cancelamento geral do SDK
* `COMPONENT_LICENSE_ERROR` (`VOC_002`): A licença do componente está incorreta
* `EMPTY_LICENSE` (`VOC_003`): A string de licença está vazia
* `FETCH_DATA_ERROR` (`VOC_504`): Erro ao coletar o resultado
* `FLOW_ERROR` (`VOC_510`): Erro no processo de flow
* `FLOW_TRACKING_ERROR` (`VOC_507`): Erro no tracking do flow
* `FLOW_VIDEO_RECORDING_ERROR` (`VOC_506`): Erro na gravação de vídeo do flow
* `INITIALIZATION_ERROR` (`VOC_004`): Erro de inicialização
* `INTERNAL_ERROR` (`VOC_509`): Erro interno
* `INTERNAL_LICENSE_ERROR` (`VOC_500`): Erro interno relacionado à licença
* `MANAGER_NOT_INITIALIZED` (`VOC_505`): Os managers são nulos
* `NO_DATA_ERROR` (`VOC_005`): Os dados de entrada são nulos
* `OPERATION_NOT_CREATED` (`VOC_006`): Não há nenhuma operação em andamento
* `PERMISSION_DENIED` (`VOC_501`): O usuário recusou as permissões
* `TIMEOUT` (`VOC_001`): Timeout no processo
* `TRACKING_STEP_ERROR` (`VOC_508`): Erro na etapa de tracking

### Recebimento do resultado correto - *data* <a href="#id-62-recepcion-del-resultado-correcto-data" id="id-62-recepcion-del-resultado-correcto-data"></a>

Na parte de SdkResult.Success - *data*, teremos a classe *VoiceResult*.

Os campos retornados no resultado são os seguintes:

**audios**

Contém uma lista de áudios capturados no formato ByteArray.

**tokenizedAudios**

Contém a lista de áudios capturados no formato tokenizado da Facephi.

***

## Informações avançadas <a href="#id-7-informacion-avanzada" id="id-7-informacion-avanzada"></a>

Esta seção complementa as informações do componente.

### Configuração avançada do componente <a href="#id-71-configuracion-avanzada-del-componente" id="id-71-configuracion-avanzada-del-componente"></a>

Para iniciar o componente atual, será necessário criar um objeto *VoiceConfigurationData* que será a configuração do controlador do componente.

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

* `phrases`: (`Array<String>`, obrigatório) Indica a(s) frase(s) necessária(s) para a captura.
* `vibrationEnabled`: (`Boolean`, por padrão `true`) Indica a ativação da vibração quando o widget for concluído com sucesso.
* `showTutorial`: (`Boolean`, por padrão `true`) Indica se o componente ativa a tela de tutorial. Nessa tela, é explicado de forma intuitiva como a captura é realizada.
* `extractionTimeout`: (`Long`, por padrão `60000` ms) Define o tempo máximo durante o qual a captura pode ser realizada.
* `showDiagnostic`: (`Boolean`, por padrão `true`) Exibe telas de diagnóstico ao final do processo.
* `enableQualityCheck`: (`Boolean`, por padrão `true`) Ativa ou desativa a verificação da qualidade do áudio. Recomenda-se mantê-la sempre ativa.
* `showPreviousTip`: (`Boolean`, por padrão `true`) Exibe uma tela antes de iniciar a captura, com informações sobre o processo a ser realizado e um botão para iniciá-la.

***

## 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 (explicadas no documento de [Personalização do SDK](https://docs.facephi.com/docs.facephi-pt-br/sdks/sdk-mobile/android-sdk/personalizacion.md)), este componente permite especificamente modificar sua interface.

### Textos <a href="#id-81-textos" id="id-81-textos"></a>

Os textos podem ser personalizados adicionando um arquivo XML de recursos ao aplicativo cliente e substituindo os valores padrão.

```kotlin
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- Previous Tip -->
    <string name="voice_widget_tip_message">Speak clearly and loudly.<br/><br/>Make sure you are in a quiet environment.</string>
    <string name="voice_widget_tip_message_alt">Speak clearly and loudly. Make sure you are in a quiet environment.</string>
    <string name="voice_widget_tip_title">Speech recognition</string>
    <string name="voice_widget_tip_button">Continue</string>
    <string name="voice_widget_tip_anim_alt">Animation in which a person appears holding the phone in front of their face and speaking directly to it. Before you begin, if you are using a screen reader, use headphones.</string>
    <!-- Process -->
    <string name="voice_widget_success_message">Gravação registrada</string>
    <string name="voice_widget_speech_message">Fale claramente e perto do microfone</string>
    <string name="voice_widget_speech_more_message">Continue falando</string>
    <string name="voice_widget_speech_empty_message" translatable="false"></string>
    <string name="voice_widget_read_message">Diga em voz alta:</string>
    <string name="voice_widget_speech_noisy_message">Há muito ruído de fundo. Tente ir para um ambiente silencioso</string>
    <string name="voice_widget_success_records_message">gravações bem-sucedidas</string>
    <string name="voice_widget_phrase_generic_error_message">Repita a frase.</string>
    <string name="voice_widget_phrase_long_silence_message">Fale por 2 segundos ou mais.</string>
    <string name="voice_widget_phrase_long_reverberation_message">Há muito eco. Tente outro ambiente.</string>
    <string name="voice_widget_quality_check_error_message">A qualidade do áudio é insuficiente.</string>
    <string name="voice_widget_multiple_speakers_error_message">Vozes de fundo detectadas. Certifique-se de estar em um ambiente silencioso.</string>
    <!-- Diagnóstico -->
    <string name="voice_widget_timeout_title">Tempo esgotado</string>
    <string name="voice_widget_timeout_desc">Não foi possível identificar você. Tente novamente.</string>
    <string name="voice_widget_internal_error_title">Ocorreu um problema técnico</string>
    <string name="voice_widget_internal_error_desc">Pedimos desculpas. Não foi possível fazer a captura</string>
    <string name="voice_widget_exit_alert_accept">Aceitar</string>
    <string name="voice_widget_exit_alert_cancel">Cancelar</string>
    <string name="voice_widget_exit_alert_question">Tem certeza de que deseja encerrar o processo?</string>
    <string name="voice_widget_back_button_alt">Voltar</string>
    <string name="voice_widget_close_button_alt">Fechar</string>
    <string name="voice_widget_logo_alt">Logotipo</string>

</resources>

```

```
                                                                                    |
```

### Animações <a href="#id-82-animaciones" id="id-82-animaciones"></a>

Se quiser modificar as animações (lottie) do SDK, inclua animações com o mesmo nome na pasta res/raw/ do aplicativo.

```
voice_anim_enroll_ko.json
voice_anim_enroll_ok.json
voice_anim_enroll_progress.json
voice_anim_intro.json
```
