Transloadit

Comprimir arquivos

🤖/file/compress cria arquivos compactados a partir de arquivos ou de resultados de conversão de arquivos.

/file/compress Robot

Exemplo de uso

Compactar arquivos enviados por upload em um arquivo ZIP:

{
  "steps": {
    "compressed": {
      "format": "zip",
      "robot": "/file/compress",
      "use": {
        "bundle_steps": true,
        "steps": [
          ":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"
    }
  ]
}

  • format

    tar | zip(padrão: "tar")

    O formato do arquivo compactado a ser criado. Os valores aceitos são "tar" e "zip".

    Observe que "tar" sem definir gzip como true resulta em um arquivo sem qualquer compressão.

  • gzip

    boolean(padrão: false)

    Determina se o arquivo resultante também deve ser compactado com Gzip. A compressão Gzip só é aplicada se você usar o formato "tar".

  • password

    string | null(padrão: null)

    Permite criptografar todo o conteúdo do arquivo compactado com uma senha e, assim, protegê-lo contra uso não autorizado. Para descompactar o arquivo, o usuário precisará fornecer a senha em um campo de entrada de texto solicitado.

    Este parâmetro não tem efeito se o parâmetro format tiver qualquer valor diferente de "zip".

  • compression_level

    string | number(padrão: -6)

    Determina a intensidade da tentativa de compactação do arquivo. -0 não aplica compressão, o que é adequado para mídias que já estão compactadas. -1 é a opção mais rápida, com a menor compressão. -9 é a mais lenta, com a maior compressão.

    Se você estiver usando -0 em combinação com o formato tar e com gzip ativado, considere definir gzip: false em vez disso. Isso resulta em um arquivo Tar simples, ou seja, ele já não tem compressão.

  • file_layout

    advanced | simple | relative-path(padrão: "advanced")

    Determina se o arquivo compactado resultante deve conter todos os arquivos em um único diretório (o valor para isso é "simple") ou em subpastas de acordo com a explicação abaixo (o valor para isso é "advanced"). A opção "relative-path" preserva a estrutura relativa de diretórios dos arquivos de entrada.

    Arquivos com nomes iguais são numerados no layout de arquivos "simple" para evitar conflitos de nomes.

  • archive_name

    string

    O nome do arquivo compactado a ser criado (sem a extensão do arquivo).

  • path

    string

    O caminho em que cada arquivo deve ser colocado dentro do arquivo compactado. Pode incluir quaisquer Assembly Variables disponíveis. As variáveis são avaliadas por arquivo, permitindo que modelos como "${file.meta.archive_directory}/${file.name}" preservem a estrutura original de diretórios de um arquivo compactado extraído anteriormente.

    Quando este parâmetro é definido, o parâmetro file_layout é ignorado.

Demonstrações

Publicações relacionadas no blog