Videogravação - Videorecording

Este componente precisa de uma versão mínima do iOS13

Introdução

O Componente tratado no documento atual recebe o nome de VideoRecording Component. Este é responsável por capturar a tela do dispositivo em segundo plano. É voltado principalmente para a gravação do processo de Onboarding.

Na seção de Lançamento simplificado são detalhadas as etapas necessárias para a Integração básica do SDK. Nesta seção, são adicionadas as informações para o lançamento deste componente.

Dependências

Para evitar conflitos e problemas de compatibilidade, caso queira instalar o componente em um projeto que contenha uma versão antiga das bibliotecas da Facephi (Widgets), eles deverão ser totalmente removidos antes da instalação dos componentes da SDKMobile.

CocoaPods

• Atualmente as bibliotecas da FacePhi são distribuídas remotamente por meio de diferentes gerenciadores de dependências, neste caso CocoaPods. As dependências obrigatórias que deverão ter sido instaladas previamente (adicionando-as ao arquivo Podfile do projeto) são:

  pod 'FPHISDKMainComponent', '~> $VERSION'

• Para instalar o componente de Selphi, deve-se incluir a seguinte entrada no Podfile da aplicação:

  pod 'FPHISDKVideoRecordingComponent', '~> $VERSION'

SPM

• As dependências obrigatórias que deverão ter sido instaladas previamente são:

//HTTPS
https://github.com/facephi-clienters/SDK-SdkPackage-SPM.git
//SSH
[email protected]:facephi-clienters/SDK-SdkPackage-SPM.git

• Para instalar o componente de SELPHI, deve-se incluí-lo nos módulos do projeto:

//HTTPS
https://github.com/facephi-clienters/SDK-VideoRecording-SPM.git
//SSH
[email protected]:facephi-clienters/SDK-VideoRecording-SPM.git

Permissões

No aplicativo cliente onde os componentes serão integrados, é necessário incorporar o seguinte elemento no arquivo Info.plist quando a gravação for incluir áudio:

É necessário permitir o uso do microfone (NSMicrophoneUsageDescription - Privacy - Microphone Usage Description)

A permissão do microfone só é necessária se você ativar enableAudio em VideoRecordingConfigurationData. Por padrão enableAudio é false e a gravação não captura áudio.

Controladores disponíveis

Controlador	Descrição
VideoRecordingController	Controlador principal de Videogravação

Lançamento simplificado

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

Declaração do controlador

private var videoRecordingController: VideoRecordingController?

Lançamento da captura

Para iniciar a gravação de tela:

public func launchVideoRecording(viewController: UIViewController) {
    let data = VideoRecordingConfigurationData()
    let videoRecordingController = VideoRecordingController(
        data: data,
        viewController: viewController,
        output: {
            print("videoRecordingController output: \($0.errorType)")
        })
    SDKController.shared.launch(controller: videoRecordingController)
    self.videoRecordingController = videoRecordingController
}

Parar a captura

Para parar a gravação de tela:

public func stopVideoRecording() {
    self.videoRecordingController?.stopVideoRecording()
}

Recebimento de erros

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

Lista de erros:

• VRC_EMPTY_LICENSE: A string de licença está vazia

• VRC_INITIALIZATION_ERROR: Erro de inicialização

• VRC_OPERATION_NOT_CREATED: Não há nenhuma operação em andamento

• VRC_NETWORK_CONNECTION: Erro na conexão com a internet

• VRC_PERMISSION_ERROR: O usuário recusou as permissões

• VRC_SOCKET_ERROR: Erro na conexão dos serviços

• VRC_UNKNOWN_ERROR: Erro desconhecido

• VRC_VIDEO_CALL_ACTIVE: Não é possível iniciar porque há uma Videochamada ativa

• VRC_VIDEO_ERROR: Erro no processamento do vídeo

• VRC_VIDEO_RECORDING_ACTIVE: Não é possível iniciar porque o processo de gravação de vídeo está ativo

Informações avançadas

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

Configuração avançada do componente

Para lançar o componente atual, será 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.

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

Esses campos costumam ser informados apenas quando o servidor é OnPremise.

url

Caminho para o socket de vídeo

apiKey

ApiKey necessária para a conexão com o socket de vídeo

tenantId

Identificador do tenant que faz referência ao cliente atual, necessário para a conexão com o serviço de vídeo.

enableAudio

Flag que permite configurar se a videogravação terá áudio ou não. Por padrão a false.

Se enableAudio é true, você deve declarar a permissão de microfone em Info.plist (veja a seção Permissões).