> 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/video-grabacion.md).

# Gravação de vídeo - Videorecording

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

A gravação de vídeo da tela é realizada com o ***VideoRecording Component***.

Este componente é responsável por capturar a tela do dispositivo em segundo plano. Ele é voltado principalmente para a gravação do processo de onboarding.

***

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

A dependência específica do componente é:

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

***

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

| **Controlador**              | **Descrição**                                     |
| ---------------------------- | ------------------------------------------------- |
| VideoRecordingController     | Controlador principal de gravação de vídeo.       |
| StopVideoRecordingController | Controlador para interromper a gravação de vídeo. |

***

***

## Lançamento simplificado <a href="#id-4-lanzamiento-simplificado" id="id-4-lanzamiento-simplificado"></a>

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.

### Iniciar a captura <a href="#id-41-lanzamiento-de-la-captura" id="id-41-lanzamiento-de-la-captura"></a>

Para iniciar a gravação da tela:

```kotlin
val response = SDKController.launch(
    VideoRecordingController(
        VideoRecordingConfigurationData(...)
    )
)

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

```

### Parar a captura <a href="#id-42-detener-la-captura" id="id-42-detener-la-captura"></a>

Para parar a gravação da tela:

```kotlin
val response = SDKController.launch(StopVideoRecordingController())

when (response) {
    is SdkResult.Error   -> Napier.d("ERROR - ${response.error.name}")
    is SdkResult.Success -> Napier.d("APP: VIDEO RECORDING STATE (stop): ${response.data.state.name}")
}

```

### 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 'VideoRecordingError'.

Lista de erros:

* `CANCEL_BY_USER` (`VRC_000`): O usuário cancelou o processo
* `COMPONENT_LICENSE_ERROR` (`VRC_002`): A licença do componente não está correta
* `EMPTY_LICENSE` (`VRC_003`): A string da licença está vazia
* `FLOW_ERROR` (`VRC_759`): Erro no processo de flow
* `INITIALIZATION_ERROR` (`VRC_004`): Erro de inicialização
* `INTERNAL_ERROR` (`VRC_758`): Erro interno
* `OPERATION_NOT_CREATED` (`VRC_006`): Não há nenhuma operação em andamento
* `NETWORK_CONNECTION` (`VRC_750`): Erro na conexão com a internet
* `PERMISSION_ERROR` (`VRC_751`): O usuário recusou as permissões necessárias. Com `enableAudio=true` também abrange a recusa ou o fechamento da solicitação de permissão do microfone e a recusa da permissão de `MediaProjection`.
* `SOCKET_ERROR` (`VRC_752`): Erro na conexão dos serviços
* `UNKNOWN_ERROR` (`VRC_753`): Erro desconhecido
* `VIDEO_CALL_ACTIVE_ERROR` (`VRC_754`): Não é possível iniciar porque há uma videochamada ativa
* `VIDEO_ERROR` (`VRC_755`): Erro no processamento do vídeo
* `VIDEO_RECORDING_ACTIVE_ERROR` (`VRC_756`): Não é possível iniciar porque o processo de gravação de vídeo está ativo
* `FETCH_DATA_ERROR` (`VRC_757`): Erro na coleta do resultado

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

Em caso de sucesso, o campo `data` contém um objeto `VideoRecordingResult`.

* `state`: Estado da gravação. `SHARING` indica que a gravação foi iniciada e `FINISH` indica que ela foi interrompida corretamente.

## Informações avançadas

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

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

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

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

> Nota: *VideoRecordingConfigurationData* é a classe que o desenvolvedor utiliza para iniciar *VideoRecordingController*. A classe *FVideoRecordingConfigurationData* (mesmos campos, mas com `enableAudio` com o valor padrão `true`) corresponde à inicialização por meio de fluxos (*FVideoRecordingController*, configuração serializada em JSON); não é usada na integração direta com os controladores.

Os campos `url`, `apiKey` e `tenantId` normalmente **não precisam ser informados** pois são preenchidos internamente por meio da licença utilizada.

Esses campos geralmente são informados **somente** quando o **servidor** é **OnPremise**.

#### **url**

Caminho para o socket de vídeo (`String?`, por padrão `null`)

#### **apiKey**

ApiKey necessária para a conexão com o socket de vídeo (`String?`, por padrão `null`)

#### **tenantId**

Identificador do tenant que faz referência ao cliente atual, necessário para a conexão com o serviço de vídeo (`String?`, por padrão `null`).

#### **enableAudio**

Ativa a captura de áudio durante a gravação de tela. Por padrão `false`. Quando informado como `true`, o Android solicita `RECORD_AUDIO` antes da permissão de `MediaProjection`; se o usuário negar ou fechar a tela de permissões, retorna `VRC_PERMISSION_ERROR` e a gravação não é iniciada.

\ <br>
