Filtrar arquivos

🤖/file/filter direciona arquivos para diferentes Steps de codificação com base nas suas condições.

Exemplo de uso

{
  "steps": {
    "filtered": {
      "declines": [
        [
          "${file.size}",
          ">",
          "20mb"
        ]
      ],
      "error_msg": "File size must not exceed 20 MB",
      "error_on_decline": true,
      "robot": "/file/filter",
      "use": ":original"
    }
  }
}

Parâmetros

• interpolate

  boolean | Record<string, boolean>

  Controla se as Assembly Variables são interpoladas em campos individuais de instruções.

  Por padrão, a maioria dos campos de instruções dos Robots interpola Assembly Variables. Defina isso como false para tratar todos os campos de instruções como texto literal, ou defina o caminho de um campo individual como false para tratar apenas esse campo como texto literal. Para campos específicos de um Robot que são literais por padrão, defina isso como true ou defina o caminho desse campo como true para voltar a usar a interpolação.

  Use nomes de campos como path ou caminhos com pontos como ffmpeg.vf para objetos aninhados.

• output_meta

  Record<string, boolean> | boolean | Array<string>

  Permite especificar um conjunto de metadados cujo cálculo exige mais CPU e que, por isso, vem desativado por padrão para manter o processamento das suas Assemblies rápido.

  Para imagens, você pode adicionar "has_transparency": true neste objeto para extrair se a imagem contém partes transparentes e "dominant_colors": true para extrair um array de códigos de cores hexadecimais da imagem.

  Para imagens, você também pode adicionar "blurhash": true para extrair uma string BlurHash⁠ — uma representação compacta de um placeholder da imagem, útil para exibir uma prévia desfocada enquanto a imagem completa carrega.

  Para vídeos, você pode adicionar o parâmetro "colorspace": true para extrair o espaço de cores do vídeo de saída.

  Para vídeos, você também pode adicionar "interlaced": true para detectar se o vídeo é entrelaçado. Isso combina a flag computacionalmente barata field_order do ffprobe com uma passagem de amostragem idet limitada sobre os primeiros quadros da origem, expondo interlaced, field_order e um objeto de diagnóstico interlace_detection em file.meta. Isso é computacionalmente caro e cobrado de acordo.

  Para áudio, você pode adicionar "mean_volume": true para obter um único valor que representa o volume médio do arquivo de áudio.

  Você também pode definir isso como false para pular a extração de metadados e acelerar a transcodificação.

• user_meta

  Record<string, any>(padrão: {})

  Adiciona metadados JSON personalizados a cada arquivo emitido sem modificar seu conteúdo. Objetos e arrays aninhados são suportados.

  A herança depende do Robot. Os valores são mesclados com o user_meta existente no arquivo de saída; o Step atual substitui as chaves de nível superior com o mesmo nome. Atribua explicitamente as chaves necessárias quando um Robot criar novas saídas.

  Nos Steps de processamento, ${file.*} se refere à primeira entrada e ${result.*} ao arquivo emitido. Os valores são avaliados para cada saída após a execução do Robot, antes da extração subsequente de metadados e do armazenamento temporário. Em :original, os valores são avaliados para cada upload antes da extração de metadados.

  Os Steps subsequentes leem ${file.user_meta.key}. Consulte Metadados personalizados para ver um exemplo completo e as regras de herança.

• result

  boolean(padrão: false)

  Se os resultados deste Step devem estar presentes no Assembly Status JSON

• queue

  batch

  Definir a fila como “batch” rebaixa manualmente a prioridade dos Jobs deste Step, para evitar o consumo de vagas prioritárias de Jobs em Jobs que não precisam de tempo zero de espera na fila

• force_accept

  boolean(padrão: false)

  Forçar um Robot a aceitar um tipo de arquivo que ele teria ignorado.

  Por padrão, os Robots ignoram arquivos que não conhecem. O 🤖/video/encode, por exemplo, ignora tranquilamente imagens de entrada.

  Com o parâmetro force_accept definido como true, você pode forçar os Robots a aceitar todos os arquivos enviados a eles. Isso normalmente leva a erros e só deve ser usado para depuração ou para lidar com casos extremos.

• ignore_errors

  boolean | Array<meta | execute>(padrão: [])

  Ignorar erros durante fases específicas do processamento.

  Definir isso como ["meta"] fará com que o Robot ignore erros durante a extração de metadados.

  Definir isso como ["execute"] fará com que o Robot ignore erros durante a fase principal de execução.

  Definir isso como true equivale a ["meta", "execute"] e fará com que erros sejam ignorados nas duas fases.

• use

  string | Array<string> | Array<object> | object

  Especifica quais Steps usar como entrada.

  • Você pode escolher qualquer nome para os Steps, exceto ":original" (reservado para uploads de usuários tratados pela Transloadit)
  • Você pode fornecer vários Steps como entrada usando arrays:

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  • Você também pode marcar os Steps de entrada com as para transmitir intenção semântica aos Robots:

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Dica

  Provavelmente é tudo o que você precisa saber sobre use, mas você pode ver os casos de uso avançados.

• accepts

  null | string | Array<[string | string | number | null | Array<string | string | number | null>, "=" | "==" | "===" | "<" | ">" | "<=" | ">=" | mais 8 ↓, string | string | number | null | Array<string | string | number | null>]>

  Arquivos que atenderem a pelo menos um requisito serão aceitos; caso contrário, serão rejeitados. Se o valor for null, todos os arquivos serão aceitos. Se o array estiver vazio, nenhum arquivo será aceito. Omita este parâmetro ou defina-o como null quando quiser que o Step deixe todos os arquivos passarem. Exemplos:

  [["${file.mime}", "==", "image/gif"]] [["${file.size}", "<", "5kb"]]

  Para comparações numéricas (<, >, <=, >=), há suporte a valores de bytes em formato legível, como "20mb", "1gb" ou "512kb".

  Se o parâmetro condition_type estiver definido como "and", todos os requisitos deverão ser atendidos para que o arquivo seja aceito.

  Se accepts e declines forem fornecidos, os requisitos em accepts serão avaliados primeiro, antes das condições em declines.

• declines

  null | string | Array<[string | string | number | null | Array<string | string | number | null>, "=" | "==" | "===" | "<" | ">" | "<=" | ">=" | mais 8 ↓, string | string | number | null | Array<string | string | number | null>]>

  Arquivos que atenderem a pelo menos um requisito serão rejeitados; caso contrário, serão aceitos. Se o valor for null ou um array vazio, nenhum arquivo será rejeitado. Exemplos:

  [["${file.size}", ">", "1024"]] [["${file.size}", ">", "20mb"]]

  Para comparações numéricas (<, >, <=, >=), há suporte a valores de bytes em formato legível, como "20mb", "1gb" ou "512kb".

  Se o parâmetro condition_type estiver definido como "and", todos os requisitos deverão ser atendidos para que o arquivo seja rejeitado.

  Se accepts e declines forem fornecidos, os requisitos em accepts serão avaliados primeiro, antes das condições em declines.

• condition_type

  and | or(padrão: "or")

  Especifica o tipo de condição segundo o qual os elementos dos arrays accepts ou declines devem ser avaliados. Pode ser "or" ou "and".

• error_on_decline

  boolean(padrão: false)

  Se isso estiver definido como true e um ou mais arquivos forem recusados, a Assembly será interrompida e marcada com erro.

• error_msg

  string(padrão: "One of your files was declined")

  A mensagem de erro exibida para seus usuários (por exemplo, pelo Uppy) quando um arquivo é recusado e error_on_decline está definido como true.

Demonstrações

Publicações relacionadas no blog