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

# Videochamada - Videocall

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

A videochamada é realizada com o ***VideoCall Component***.

Esse componente é responsável por gerenciar a comunicação entre um usuário e um agente (videoassistência). Seus principais processos são:

* Gerenciamento interno de câmeras, microfone e permissões.
* Conexão com os serviços.

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 dependência específica do componente é:

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

***

## Controladores disponíveis

| **Controlador**         | **Descrição**                                             |
| ----------------------- | --------------------------------------------------------- |
| VideoCallController     | Controlador principal da videochamada                     |
| StopVideoCallController | Parar o compartilhamento de tela e a chamada em andamento |

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

Inicialização:

```kotlin
val response = SDKController.launch(
    VideoCallController(VideoCallConfigurationData(...))
)
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 *VideoCallConfigurationData* que será a configuração do controlador do componente.

A configuração básica necessária não precisa de nenhum parâmetro:

```kotlin
VideoCallConfigurationData()
```

## Recebimento do resultado

O lançamento retornará as informações no formato SdkResult, permitindo diferenciar entre um lançamento bem-sucedido e um malsucedido:

```kotlin
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 'VideoCallError'.

Lista de erros:

* `ACTIVITY_RESULT_MSG_ERROR` (`VCL_707`): O resultado da atividade está incorreto
* `APPLICATION_CONTEXT_ERROR` (`VCL_708`): O contexto de aplicação necessário é nulo
* `CANCEL_BY_USER` (`VCL_000`): O usuário cancelou o processo
* `CANCEL_LAUNCH` (`VCL_007`): Foi realizado um cancelamento geral do SDK
* `COMPONENT_LICENSE_ERROR` (`VCL_002`): A licença do componente está incorreta
* `EMPTY_LICENSE` (`VCL_003`): A String da licença está vazia
* `FETCH_DATA_ERROR` (`VCL_709`): Erro ao coletar o resultado
* `FLOW_ERROR` (`VCL_716`): Erro no processo de flow
* `INITIALIZATION_ERROR` (`VCL_004`): Erro de inicialização
* `INTERNAL_ERROR` (`VCL_712`): Erro interno
* `MANAGER_NOT_INITIALIZED` (`VCL_710`): Os managers são nulos
* `NETWORK_CONNECTION` (`VCL_700`): Erro na conexão com a internet
* `NO_DATA_ERROR` (`VCL_005`): Os dados de entrada são nulos
* `OPERATION_NOT_CREATED` (`VCL_006`): Não há nenhuma operação em andamento
* `PERMISSION_ERROR` (`VCL_711`): O usuário recusou as permissões
* `SCREEN_SHARING_PERMISSION_ERROR` (`VCL_701`): O usuário recusou a permissão para compartilhar a tela
* `SOCKET_ERROR` (`VCL_702`): Erro na conexão dos serviços
* `TIMEOUT` (`VCL_001`): Timeout no processo
* `VIDEO_ERROR` (`VCL_705`): Erro no processamento do vídeo
* `UNKNOWN_ERROR` (`VCL_703`): Erro desconhecido
* `VIDEO_CALL_ACTIVE` (`VCL_704`): Não é possível iniciar porque já há uma videochamada ativa
* `VIDEO_RECORDING_ACTIVE` (`VCL_706`): Não é possível iniciar porque o processo de gravação de vídeo está ativo

### 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 *VideoCallResult* que terá uma única propriedade.

* `sharingScreen`: Indica se a chamada continua ativa com o compartilhamento de tela iniciado.

Quando o resultado for Success e a flag *sharingScreen* estiver ativa, será possível ativar o compartilhamento de tela.

***

## 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 *VideoCallConfigurationData* que será a configuração do controlador do componente.

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

Os campos incluídos na configuração normalmente **não precisam ser informados** pois são preenchidos internamente por meio da licença usada.

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`).
* `activateScreenSharing`: Ativar a opção de compartilhamento de tela na chamada (`Boolean`, por padrão `false`).
* `timeout`: Tempo de espera para um agente atender à chamada (ms) (`Long`, por padrão `60000`).

### Compartilhamento de tela <a href="#id-72-compartir-pantalla" id="id-72-compartir-pantalla"></a>

Quando o usuário ativar a funcionalidade de compartilhamento de tela, o resultado será recebido no controlador com "sharingScreen = true". Isso indica que a chamada ainda está em andamento.

```kotlin
val result = SDKController.launch(
    VideoCallController(VideoCallConfigurationData(activateScreenSharing = true)))

when (result) {
    is SdkResult.Error -> {
        Napier.d("VideoCall: ERROR - ${result.error.name}")
    }

    is SdkResult.Success -> {
            Napier.d("VideoCall: OK - ScreenSharing: ${result.data.sharingScreen}")
        }
    }

```

Para encerrar a chamada, será usado o controlador StopVideoCallController.

```kotlin
val controller = StopVideoCallController()

controller.setOutput { state ->
    Napier.d { "VIDEOCALL: SCREEN SHARING STATE: ${state.name}" }
}
viewModelScope.launch {
    SDKController.launch(controller)
}
```

Os estados possíveis são:

```kotlin
AGENT_HANGUP,
PERMISSION_ERROR,
NETWORK_CONNECTION_ERROR,
UNKNOWN_ERROR,
SHARING,
CANCEL_BY_USER,
FINISH
```

O estado que indica o encerramento completo da chamada é FINISH.

***

## 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>
    <!-- Video call -->
    <string name="video_widget_call_component_text_waiting_agent_title">Conectando com um assistente...</string>
    <string name="video_widget_call_component_local">Você</string>
    <string name="video_widget_call_component_agent">Assistente</string>
    <string name="video_widget_call_component_exit">Sair</string>
    <string name="video_widget_call_component_text_finish">A assistência por vídeo foi concluída</string>
    <string name="video_widget_call_component_phone_button_alt">Telefone</string>
    <string name="video_widget_call_component_switch_button_alt">Trocar câmera</string>
    <string name="video_widget_call_component_restart">TENTAR NOVAMENTE</string>
    <string name="video_widget_call_component_timeout_title">Tempo esgotado</string>
    <string name="video_widget_call_component_timeout_desc">Não foi possível se conectar com um agente.</string>
    <string name="video_widget_call_component_internal_error_title">Ocorreu um problema técnico</string>
    <string name="video_widget_call_component_internal_error_desc">Não foi possível acessar um assistente.</string>
    <string name="video_widget_call_component_close_button_alt">Fechar</string>
    <string name="video_widget_call_component_back_button_alt">Voltar</string>
    <string name="video_widget_call_component_exit_alert_question">Deseja encerrar a chamada?</string>
    <string name="video_widget_call_component_exit_alert_finish">Encerrar</string>
    <string name="video_widget_call_component_exit_alert_accept">Aceitar</string>
    <string name="video_widget_call_component_exit_alert_cancel">Cancelar</string>
    <string name="video_widget_call_component_skip">PULAR</string>
    <string name="video_widget_call_component_share_button_alt">Compartilhar tela</string>
</resources>

```

### Cores <a href="#id-82-colores" id="id-82-colores"></a>

```xml
<color name="colorVideoCallActionsBackground">#30333d</color>
<color name="colorVideoCallButtonBackground">#FF526080</color>
```

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

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

```
video_call_anim_waiting.json
```
