> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge/oz-knowledge/pt-br/guias/developer-guide/sdk/oz-mobile-sdk/flutter/flutter-sdk-methods-and-properties.md).

# Métodos e propriedades do Flutter SDK

### clearActionVideos <a href="#clearactionvideos" id="clearactionvideos"></a>

Exclui todos os vídeos de ação do sistema de arquivos (iOS 8.4.0 e mais recentes, Android).

**Retorna**

Future\<Void>.

### getSDKVersion <a href="#getsdkversion" id="getsdkversion"></a>

Retorna a versão do SDK.

**Retorna**

Future\<String>.

### initSDK <a href="#initsdk" id="initsdk"></a>

Inicializa o SDK com fontes de licença.

| **Parâmetro** | **Tipo**      | **Descrição**         |
| ------------- | ------------- | --------------------- |
| licenses      | List\<String> | Uma lista de licenças |

**Retorna**

| **Caso** | **Texto**                                 |
| -------- | ----------------------------------------- |
| True     | A inicialização foi concluída com sucesso |
| False    | Erro de inicialização                     |

### **setApiConnectionWithCredentials** <a href="#setapiconnectionwithcredentials" id="setapiconnectionwithcredentials"></a>

Autenticação via credenciais.

| **Parâmetro**      | **Tipo**          | **Descrição**           |
| ------------------ | ----------------- | ----------------------- |
| e-mail             | String            | E-mail do usuário       |
| senha              | String            | Senha do usuário        |
| host               | String            | URL do servidor         |
| sslPins (opcional) | [sslPin](#sslpin) | Certificados permitidos |

**Retorna**

| **Caso** | **Texto**                                                                                                      |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| SUCCESS  | Nada (void)                                                                                                    |
| FAILED   | <p>PlatformException:</p><ul><li>code = AUTHENTICATION\_FAILED</li><li>message = detalhes da exceção</li></ul> |

### **setApiConnectionWithToken** <a href="#setapiconnectionwithtoken" id="setapiconnectionwithtoken"></a>

Autenticação via token de acesso.

| **Parâmetro**      | **Tipo**          | **Descrição**           |
| ------------------ | ----------------- | ----------------------- |
| token              | String            | Token de acesso         |
| host               | String            | URL do servidor         |
| sslPins (opcional) | [sslPin](#sslpin) | Certificados permitidos |

**Retorna**

| **Caso** | **Texto**                                                                                                      |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| SUCCESS  | Nada (void)                                                                                                    |
| FAILED   | <p>PlatformException:</p><ul><li>code = AUTHENTICATION\_FAILED</li><li>message = detalhes da exceção</li></ul> |

### **setEventConnectionWithCredentials** <a href="#seteventconnectionwithcredentials" id="seteventconnectionwithcredentials"></a>

Conexão com o servidor de telemetria via credenciais.

| **Parâmetro**      | **Tipo**          | **Descrição**           |
| ------------------ | ----------------- | ----------------------- |
| e-mail             | String            | E-mail do usuário       |
| senha              | String            | Senha do usuário        |
| host               | String            | URL do servidor         |
| sslPins (opcional) | [sslPin](#sslpin) | Certificados permitidos |

**Retorna**

| **Caso** | **Texto**                                                                                                      |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| SUCCESS  | Nada (void)                                                                                                    |
| FAILED   | <p>PlatformException:</p><ul><li>code = AUTHENTICATION\_FAILED</li><li>message = detalhes da exceção</li></ul> |

### **setEventConnectionWithToken** <a href="#seteventconnectionwithtoken" id="seteventconnectionwithtoken"></a>

Conexão com o servidor de telemetria via token de acesso.

| **Parâmetro**      | **Tipo**          | **Descrição**           |
| ------------------ | ----------------- | ----------------------- |
| token              | String            | Token de acesso         |
| host               | String            | URL do servidor         |
| sslPins (opcional) | [sslPin](#sslpin) | Certificados permitidos |

**Retorna**

| **Caso** | **Texto**                                                                                                      |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| SUCCESS  | Nada (void)                                                                                                    |
| FAILED   | <p>PlatformException:</p><ul><li>code = AUTHENTICATION\_FAILED</li><li>message = detalhes da exceção</li></ul> |

### isLoggedIn <a href="#isloggedin" id="isloggedin"></a>

Verifica se existe um token de acesso.

**Retorna**

| **Caso**           | **Retorna** |
| ------------------ | ----------- |
| O token existe     | True        |
| O token não existe | False       |

### logout <a href="#logout" id="logout"></a>

Exclui o token de acesso salvo.

**Retorna**

Nada (void).

### supportedLanguages <a href="#supportedlanguages" id="supportedlanguages"></a>

Retorna a lista de idiomas suportados pelo SDK.

**Retorna**

List<[Locale](#enum-locale)>.

### startLiveness <a href="#executeliveness" id="executeliveness"></a>

Inicia o processo de captura de vídeo do Liveness.

| **Parâmetro** | **Tipo**                                             | **Descrição**                                        |
| ------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| actions       | List<[VerificationAction](#enum-verificationaction)> | Ações a executar                                     |
| mainCamera    | Boolean                                              | Use a câmera principal (`True`) ou frontal (`False`) |

### setSelfieLength

Define a duração do **Selfie** gesto (em milissegundos).

| **Parâmetro** | **Tipo** | **Descrição**                                                                                          |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| selfieLength  | Int      | A duração do **Selfie** gesto (em milissegundos). Deve estar entre 500-5000 ms, a duração padrão é 700 |

**Retorna**

Erro, se houver.

### Analyze <a href="#analyze" id="analyze"></a>

Inicia as análises.

| **Parâmetro**        | **Tipo**                   | **Descrição**                                                         |
| -------------------- | -------------------------- | --------------------------------------------------------------------- |
| analysis             | List<[Análise](#analysis)> | A lista de estruturas de análise                                      |
| folder ID (opcional) | String                     | ID da pasta, se quiser realizar uma análise para uma pasta específica |
| uploadMedia          | List<[Mídia](#media)>      | A lista dos vídeos capturados                                         |
| params               | Map\<String, Any>          | Parâmetros adicionais                                                 |

**Retorna**

List<[RequestResult](#requestresult)>.

### setLocalization (Android) / setLocalizationValue (iOS) <a href="#setlocalization" id="setlocalization"></a>

Define a localidade do SDK.

| **Parâmetro** | **Tipo**               | **Descrição**   |
| ------------- | ---------------------- | --------------- |
| locale        | [Locale](#enum-locale) | O idioma do SDK |

### attemptSettings <a href="#attemptsettings" id="attemptsettings"></a>

O número de tentativas antes que o SDK retorne um erro.

| **Parâmetro** | **Tipo** | **Descrição**                                                                        |
| ------------- | -------- | ------------------------------------------------------------------------------------ |
| singleCount   | int      | Tentativas em uma única ação/gesto                                                   |
| commonCount   | int      | Número total de tentativas em todas as ações/gestos se uma sequência deles for usada |

### setUICustomization <a href="#setuicustomization" id="setuicustomization"></a>

Define os valores de personalização da interface do usuário para OzLivenessSDK. Os valores são descritos na **estruturas de personalização** seção. As estruturas podem ser encontradas no arquivo lib\customization.dart.

#### setFaceAlignmentTimeout <a href="#setfacealignmenttimeout" id="setfacealignmenttimeout"></a>

Define o tempo limite para o alinhamento facial das ações.

| **Parâmetro** | **Tipo** | **Descrição**                 |
| ------------- | -------- | ----------------------------- |
| timeout       | int      | Tempo limite em milissegundos |

### **Fontes e outros recursos personalizados** <a href="#fonts-and-other-customized-resources" id="fonts-and-other-customized-resources"></a>

#### **Para iOS** <a href="#for-ios" id="for-ios"></a>

Adicione fontes e recursos drawable ao **application/ios** projeto.

#### **Para Android** <a href="#for-android" id="for-android"></a>

Fontes e imagens devem ser colocadas nas pastas correspondentes:

`ozforensics_flutter_plugin\android\src\main\res\drawable ozforensics_flutter_plugin\android\src\main\res\font`

## **estruturas de personalização** <a href="#customization-structures" id="customization-structures"></a>

Eles são definidos no arquivo customization.dart.

### UICustomization <a href="#uicustomization" id="uicustomization"></a>

Contém as informações sobre os parâmetros de personalização.

#### ToolbarCustomization <a href="#toolbarcustomization" id="toolbarcustomization"></a>

Parâmetros de personalização da barra de ferramentas.

| **Parâmetro**    | **Tipo** | **Descrição**                            |
| ---------------- | -------- | ---------------------------------------- |
| closeButtonIcon  | String   | Ícone do botão Fechar recebido do plugin |
| closeButtonColor | String   | Cor #XXXXXX                              |
| titleText        | String   | Texto do cabeçalho                       |
| titleFont        | String   | Fonte do texto                           |
| titleSize        | int      | Tamanho da fonte                         |
| titleFontStyle   | String   | Estilo da fonte                          |
| titleColor       | String   | Cor #XXXXXX                              |
| titleAlpha       | int      | Opacidade do texto do cabeçalho          |
| isTitleCentered  | bool     | Centraliza o texto                       |
| backgroundColor  | String   | Cor de fundo do cabeçalho #XXXXXX        |
| backgroundAlpha  | int      | Opacidade do fundo do cabeçalho          |

#### CenterHintCustomization <a href="#centerhintcustomization" id="centerhintcustomization"></a>

Parâmetros de personalização da dica central.

| **Parâmetro**    | **Tipo** | **Descrição**      |
| ---------------- | -------- | ------------------ |
| textFont         | String   | Fonte do texto     |
| textFontStyle    | String   | Estilo da fonte    |
| textColor        | String   | Cor #XXXXXX        |
| textSize         | int      | Tamanho da fonte   |
| verticalPosition | int      | Posição Y          |
| textAlpha        | int      | Opacidade do texto |
| centerBackground | bool     | Centraliza o texto |

#### HintAnimation <a href="#hintanimation" id="hintanimation"></a>

Parâmetros de personalização da animação da dica.

| **Parâmetro**       | **Tipo** | **Descrição**                               |
| ------------------- | -------- | ------------------------------------------- |
| hideAnimation       | bool     | Oculta a animação da dica                   |
| animationIconSize   | int      | Tamanho do ícone da animação em px (40-160) |
| hintGradientColor   | String   | Cor #XXXXXX                                 |
| hintGradientOpacity | int      | Cor do gradiente                            |

#### FaceFrameCustomization <a href="#faceframecustomization" id="faceframecustomization"></a>

Parâmetros de personalização da moldura ao redor do rosto.

| **Parâmetro**             | **Tipo** | **Descrição**                         |
| ------------------------- | -------- | ------------------------------------- |
| geometryType              | String   | Formato da moldura recebido do plugin |
| geometryTypeRadius        | int      | Raio dos cantos do retângulo          |
| strokeWidth               | int      | Largura do traço da moldura           |
| strokeFaceNotAlignedColor | String   | Cor #XXXXXX                           |
| strokeFaceAlignedColor    | String   | Cor #XXXXXX                           |
| strokeAlpha               | int      | Opacidade do traço                    |
| strokePadding             | int      | Espaçamento do traço                  |

#### VersionLabelCustomization <a href="#versionlabelcustomization" id="versionlabelcustomization"></a>

Parâmetros de personalização da versão do SDK.

| **Parâmetro** | **Tipo** | **Descrição**      |
| ------------- | -------- | ------------------ |
| textFont      | String   | Fonte do texto     |
| textFontStyle | String   | Estilo da fonte    |
| textColor     | String   | Cor #XXXXXX        |
| textSize      | int      | Tamanho da fonte   |
| textAlpha     | int      | Opacidade do texto |

#### BackgroundCustomization <a href="#backgroundcustomization" id="backgroundcustomization"></a>

Parâmetros de personalização do plano de fundo.

| **Parâmetro**   | **Tipo** | **Descrição**               |
| --------------- | -------- | --------------------------- |
| backgroundColor | String   | Cor #XXXXXX                 |
| backgroundAlpha | int      | Opacidade do plano de fundo |

## **Estruturas do Flutter** <a href="#flutter-structures" id="flutter-structures"></a>

Definidas no arquivo models.dart.

#### enum Locale <a href="#enum-locale" id="enum-locale"></a>

Armazena as informações do idioma.

| **Caso** | **Descrição**          |
| -------- | ---------------------- |
| en       | Inglês                 |
| hy       | Armênio                |
| kk       | Cazaque                |
| ky       | Quirguiz               |
| tr       | Turco                  |
| es       | Espanhol               |
| pt\_br   | Português (brasileiro) |

#### enum MediaType <a href="#enum-mediatype" id="enum-mediatype"></a>

O tipo de mídia capturada.

| **Caso**      | **Descrição**          |
| ------------- | ---------------------- |
| movimento     | Uma mídia com uma ação |
| documentBack  | O verso do documento   |
| documentFront | A frente do documento  |

#### enum FileType <a href="#enum-filetype" id="enum-filetype"></a>

O tipo de mídia capturada.

| **Caso**      | **Descrição**            |
| ------------- | ------------------------ |
| documentPhoto | Uma foto de um documento |
| video         | Um vídeo                 |
| shotSet       | Um arquivo de quadros    |

#### enum MediaTag <a href="#enum-mediatag" id="enum-mediatag"></a>

Contém uma ação do vídeo capturado.

<mark style="background-color:red;">O</mark> <mark style="background-color:red;">**Captura única**</mark> <mark style="background-color:red;">gesture está sendo descontinuado. O suporte terminará em 31 de dezembro de 2026. Planeje sua migração.</mark>

| **Caso**           | **Descrição**                                          |
| ------------------ | ------------------------------------------------------ |
| blank              | Um vídeo sem gesto                                     |
| photoSelfie        | Uma foto de selfie                                     |
| videoSelfieOneShot | Um vídeo com a melhor captura obtida                   |
| videoSelfieScan    | Um vídeo com o gesto de escaneamento                   |
| videoSelfieEyes    | Um vídeo com o gesto de piscar                         |
| videoSelfieSmile   | Um vídeo com o gesto de sorrir                         |
| videoSelfieHigh    | Um vídeo com o gesto de levantar a cabeça              |
| videoSelfieDown    | Um vídeo com o gesto de inclinar a cabeça para baixo   |
| videoSelfieRight   | Um vídeo com o gesto de virar a cabeça para a direita  |
| videoSelfieLeft    | Um vídeo com o gesto de virar a cabeça para a esquerda |
| photoIdPortrait    | Uma foto de um documento                               |
| photoIdBack        | Uma foto do verso do documento                         |
| photoIdFront       | Uma foto da frente do documento                        |

#### Mídia <a href="#media" id="media"></a>

Armazena informações sobre a mídia.

| **Parâmetro**      | **Tipo**                                       | **Descrição**                                                                  | **Platform** |
| ------------------ | ---------------------------------------------- | ------------------------------------------------------------------------------ | ------------ |
| fileType           | [FileType](#enum-filetype)                     | O tipo do arquivo                                                              | Android      |
| movimento          | [VerificationAction](#enum-verificationaction) | Uma ação em uma mídia                                                          | iOS          |
| mediatype          | String                                         | Um tipo de mídia                                                               | iOS          |
| videoPath          | String                                         | Um caminho para um vídeo                                                       |              |
| bestShotPath       | String                                         | caminho da melhor captura em PNG para vídeo ou caminho da imagem para Liveness |              |
| preferredMediaPath | String                                         | URL do contêiner de mídia da API                                               |              |
| photoPath          | String                                         | Um caminho para uma foto                                                       |              |
| archivePath        | String                                         | Um caminho para um arquivo                                                     |              |
| tag                | [MediaTag](#enum-mediatag)                     | Uma tag para a mídia                                                           | Android      |

#### RequestResult <a href="#requestresult" id="requestresult"></a>

Armazena informações sobre o resultado da análise.

| **Parâmetro**   | **Tipo**                 | **Descrição**                                                                                  | **Platform**    |
| --------------- | ------------------------ | ---------------------------------------------------------------------------------------------- | --------------- |
| folderId        | String                   | O identificador da pasta                                                                       |                 |
| tipo            | [Tipo](#enum-type)       | O tipo da análise                                                                              |                 |
| errorCode       | int                      | O código de erro                                                                               | Somente Android |
| errorMessage    | String                   | A mensagem de erro                                                                             |                 |
| mode            | [Modo](#enum-mode)       | O modo da análise                                                                              |                 |
| confidenceScore | Double                   | A pontuação resultante                                                                         |                 |
| resolution      | [Resolução](#resolution) | O resultado da análise concluída                                                               |                 |
| status          | Boolean                  | <p>O estado da análise:</p><p><code>true</code>- success;</p><p><code>false</code>- failed</p> |                 |

#### Análise <a href="#analysis" id="analysis"></a>

Armazena dados sobre uma única análise.

| **Parâmetro**         | **Tipo**                                             | **Descrição**                                                                                                                          |
| --------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| tipo                  | [Tipo](#enum-type)                                   | O tipo da análise                                                                                                                      |
| mode                  | [Modo](#enum-mode)                                   | O modo da análise                                                                                                                      |
| mediaList             | List<[Mídia](#media)>                                | Mídia a analisar                                                                                                                       |
| params                | Map\<String, String>                                 | Parâmetros adicionais de análise                                                                                                       |
| sizeReductionStrategy | [SizeReductionStrategy](#enum-sizereductionstrategy) | Define qual tipo de mídia é enviada ao servidor no caso da análise híbrida, assim que a análise no dispositivo é concluída com sucesso |

## **Estruturas** <a href="#structures" id="structures"></a>

### enum Type <a href="#enum-type" id="enum-type"></a>

Tipo de análise.

| **Caso** | **Descrição**                                                                                                                            |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| biometry | O algoritmo que permite comparar várias mídias e verificar se as pessoas nelas são a mesma pessoa ou não                                 |
| quality  | O algoritmo que visa verificar se uma pessoa em um vídeo é um ser humano real agindo de boa-fé, e não uma falsificação de qualquer tipo. |

### enum Mode <a href="#enum-mode" id="enum-mode"></a>

Modo de análise.

| **Caso**    | **Descrição**                                                                                                                                                                       |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| onDevice    | A análise no dispositivo sem necessidade de servidor                                                                                                                                |
| serverBased | A análise baseada em servidor                                                                                                                                                       |
| hybrid      | A análise híbrida para Liveness: se a pontuação recebida de uma análise no dispositivo for muito alta, o sistema inicia uma análise baseada em servidor como verificação adicional. |

### enum VerificationAction <a href="#enum-verificationaction" id="enum-verificationaction"></a>

Contém a ação do vídeo capturado.

<mark style="background-color:red;">Em 1º de janeiro de 2027, o gesto One Shot ficará indisponível. Planeje sua</mark> [<mark style="background-color:red;">migração</mark>](/oz-knowledge/oz-knowledge/pt-br/guias/developer-guide/guias-de-migracao/migracao-do-gesto-one-shot.md)<mark style="background-color:red;">.</mark>

| **Caso**  | **Descrição**                                      |
| --------- | -------------------------------------------------- |
| oneShot   | A melhor captura do vídeo gravado                  |
| blank     | Uma selfie com verificação de alinhamento do rosto |
| scan      | Escanear                                           |
| headRight | Cabeça virada para a direita                       |
| headLeft  | Cabeça virada para a esquerda                      |
| headDown  | Cabeça inclinada para baixo                        |
| headUp    | Cabeça erguida                                     |
| eyeBlink  | Blink                                              |
| smile     | Smile                                              |

### Resolução <a href="#resolution" id="resolution"></a>

O status geral de todas as análises aplicadas à pasta criada.

| **Caso**         | **Descrição**                                                                                                |
| ---------------- | ------------------------------------------------------------------------------------------------------------ |
| failed           | Uma ou mais análises falharam devido a algum erro e não puderam ser concluídas                               |
| declined         | A verificação falhou (por exemplo, os rostos não correspondem ou algum ataque de spoofing foi detectado)     |
| success          | Tudo correu bem, a verificação foi bem-sucedida (por exemplo, os rostos correspondem ou Liveness confirmada) |
| operatorRequired | O resultado deve ser verificado adicionalmente por um operador humano                                        |

### enum SizeReductionStrategy <a href="#enum-sizereductionstrategy" id="enum-sizereductionstrategy"></a>

Define qual tipo de mídia é enviada ao servidor no caso da análise híbrida, assim que a análise no dispositivo é concluída com sucesso. Por padrão, o sistema envia o vídeo compactado.

| uploadOriginal   | O vídeo original                                       |
| ---------------- | ------------------------------------------------------ |
| uploadCompressed | O vídeo compactado                                     |
| uploadBestShot   | A melhor captura extraída do vídeo                     |
| uploadNothing    | Nada é enviado (observe que nenhuma pasta será criada) |

### sslPin

Contém informações sobre os [certificados na whitelist](/oz-knowledge/oz-knowledge/pt-br/guias/developer-guide/sdk/oz-mobile-sdk/security-recommendations.md).

|               |                             |                                        |
| ------------- | --------------------------- | -------------------------------------- |
| **Parâmetro** | **Tipo**                    | **Descrição**                          |
| hash          | String                      | Hash da chave SHA256 em base64         |
| expired\_at   | Timestamp UNIX, horário UTC | A data de expiração do certificado, ms |

## **Recursos de personalização** <a href="#customization-resources" id="customization-resources"></a>

Este é um Map para definir os recursos específicos da plataforma no nível do plugin.

### closeButtonIcon <a href="#closebuttonicon" id="closebuttonicon"></a>

Esta chave é um Map para o ícone do botão Fechar.

| **Chave** | **Valor**                                         |
| --------- | ------------------------------------------------- |
| Fechar    | Recurso drawable do Android / recurso Pods do iOS |
| Seta      | Recurso drawable do Android / recurso Pods do iOS |

### titleFont <a href="#titlefont" id="titlefont"></a>

Esta chave é um Map contendo os dados das fontes enviadas.

| **Chave**                          | **Valor**                                                                                          |
| ---------------------------------- | -------------------------------------------------------------------------------------------------- |
| Nome da fonte da aplicação Flutter | Recurso de fonte do Android / recurso Pods do iOS, usado para recuperar a fonte no nível do plugin |

### titleStyle <a href="#titlestyle" id="titlestyle"></a>

Esta chave é um Map contendo os dados dos estilos de fonte enviados.

| **Chave**                                    | **Valor**                                                            |
| -------------------------------------------- | -------------------------------------------------------------------- |
| Nome do estilo de fonte da aplicação Flutter | Nome do estilo recuperado para a criação da fonte no nível do plugin |

### faceFrameGeometry <a href="#faceframegeometry" id="faceframegeometry"></a>

Esta chave é um Map contendo os dados da forma da moldura.

| **Chave** | **Valor**        |
| --------- | ---------------- |
| Oval      | Forma oval       |
| Rectangle | Forma retangular |

## contêiner de dados OzCapsula

Os métodos abaixo se aplicam ao novo recurso – [contêiner de dados OzCapsula](/oz-knowledge/oz-knowledge/pt-br/geral/conceitos-chave-de-oz-liveness-e-biometria/formato-proprietario-conteiner-de-dados-ozcapsula.md) que foi implementado na 9.1.0.

### createMediaCaptureScreen

Captura o arquivo de mídia com todas as informações necessárias e o empacota em um contêiner de dados.

| **Parâmetro** | **Tipo**       | **Descrição**                               |
| ------------- | -------------- | ------------------------------------------- |
| solicitação   | CaptureRequest | Detecta uma solicitação de captura de vídeo |
| sessionToken  | String         | Token necessário para o fluxo OzCapsula     |

**Retorna**

Void. O contêiner capturado é entregue por meio do `livenessResult` stream: `Stream<DataContainer>`.

### getContainerBytes

Recupera os bytes brutos de um contêiner de dados. Use isto ao enviar a mídia ao backend por conta própria.

| **Parâmetro** | **Tipo**      | **Descrição**                                                                                                  |
| ------------- | ------------- | -------------------------------------------------------------------------------------------------------------- |
| dataContainer | DataContainer | O contêiner de dados capturado, resultado de [createMediaCaptureScreen](#createmediacapturescreen) solicitação |

**Retorna**

Future\<Uint8List?>.

### analyze (fluxo de contêiner de dados)

Esta assinatura substitui `uploadMedia` no método analyze quando o fluxo de contêiner de dados é usado.

| **Parâmetro** | **Tipo**                   | **Descrição**                                                                                                  |
| ------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------- |
| analysis      | List<[Análise](#analysis)> | A lista de estruturas de análise                                                                               |
| dataContainer | DataContainer              | O contêiner de dados capturado, resultado de [createMediaCaptureScreen](#createmediacapturescreen) solicitação |

**Retorna**

List\<RequestResult>.

### CaptureRequest

Detecta uma solicitação de captura de vídeo.

| **Parâmetro**                  | **Tipo**                                  | **Descrição**                                                                                      |
| ------------------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------------------- |
| analysisProfileList            | List<[AnalysisProfile](#analysisprofile)> | Uma lista de objetos que contêm informações sobre mídias e análises que devem ser aplicadas a elas |
| folderMeta (optional)          | Map\<String, dynamic>                     | Metadados adicionais da pasta                                                                      |
| additionalMediaList (optional) | List<[MediaRequest](#mediarequest)>       | Arquivos de mídia que precisam ser enviados ao servidor, mas não são necessários para as análises  |
| cameraPosition (opcional)      | CameraPosition                            | `front` (padrão) – câmera frontal; `back` – câmera traseira                                        |

### AnalysisProfile

Contém informações sobre arquivos de mídia e análises que devem ser aplicadas a eles.

| **Parâmetro**     | **Tipo**                            | **Descrição**                          |
| ----------------- | ----------------------------------- | -------------------------------------- |
| tipo              | Tipo                                | Tipo de análise                        |
| mediaList         | List<[MediaRequest](#mediarequest)> | Uma lista de mídias a serem analisadas |
| params (opcional) | Map\<String, dynamic>               | Parâmetros adicionais de análise       |

### MediaRequest

Armazena informações sobre um arquivo de mídia.

{% hint style="warning" %}
Observe: você deve adicionar `actionMedia` OU `userMedia`, esses parâmetros são mutuamente exclusivos.
{% endhint %}

| **Parâmetro**        | **Tipo**                    | **Descrição**                                                                     |
| -------------------- | --------------------------- | --------------------------------------------------------------------------------- |
| id (opcional)        | String (UUID v4)            | ID da mídia. Gerado automaticamente se não for fornecido                          |
| actionMedia          | [ActionMedia](#actionmedia) | Uma ação que o usuário deve realizar em um vídeo                                  |
| userMedia            | [UserMedia](#usermedia)     | Um arquivo de mídia externo, por exemplo, uma referência ou uma foto de documento |
| mediaMeta (opcional) | Map\<String, dynamic>       | Metadados da mídia                                                                |

#### ActionMedia

Um arquivo de mídia com uma ação que o usuário deve executar.

| **Parâmetro**        | **Tipo**                                       | **Descrição**                                            |
| -------------------- | ---------------------------------------------- | -------------------------------------------------------- |
| action               | [VerificationAction](#enum-verificationaction) | Uma ação que o usuário deve realizar em um vídeo         |
| id (opcional)        | String (UUID v4)                               | ID da mídia. Gerado automaticamente se não for fornecido |
| mediaMeta (opcional) | Map\<String, dynamic>                          | Metadados da mídia                                       |

#### UserMedia

Um arquivo de mídia externo, por exemplo, uma referência ou uma foto de documento.

| **Parâmetro**        | **Tipo**              | **Descrição**              |
| -------------------- | --------------------- | -------------------------- |
| media                | [Mídia](#media)       | O arquivo de mídia externo |
| id (opcional)        | String                | ID da mídia                |
| mediaMeta (opcional) | Map\<String, dynamic> | Metadados da mídia         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.ozforensics.com/oz-knowledge/oz-knowledge/pt-br/guias/developer-guide/sdk/oz-mobile-sdk/flutter/flutter-sdk-methods-and-properties.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.