Comprimir archivos

🤖/file/compress crea archivos comprimidos a partir de archivos o resultados de conversión.

Ejemplo de uso

{
  "steps": {
    "compressed": {
      "robot": "/file/compress",
      "use": {
        "steps": [
          ":original"
        ],
        "bundle_steps": true
      },
      "format": "zip"
    }
  }
}

Parámetros

• interpolate

  boolean | Record<string, boolean>

  Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

  De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en false para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en false para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en true o la ruta de ese campo en true para volver a habilitar la interpolación.

  Usa nombres de campos como path o rutas con puntos como ffmpeg.vf para los objetos anidados.

• output_meta

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

  Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para que tus Assemblies se procesen rápidamente.

  Para imágenes, puedes añadir "has_transparency": true a este objeto para determinar si la imagen contiene partes transparentes y "dominant_colors": true para extraer un array de códigos de color hexadecimales de la imagen.

  Para imágenes, también puedes añadir "blurhash": true para extraer una cadena BlurHash⁠, una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

  Para videos, puedes añadir el parámetro "colorspace": true para extraer el espacio de color del video de salida.

  Para videos, también puedes añadir "interlaced": true para detectar si el video está entrelazado. Esto combina el indicador field_order de ffprobe, cuyo costo en recursos de procesamiento es bajo, con una pasada de muestreo limitada mediante idet sobre los primeros fotogramas de la fuente, y expone interlaced, field_order y un objeto de diagnóstico interlace_detection en file.meta. Esto requiere muchos recursos computacionales y se factura en consecuencia.

  Para audio, puedes añadir "mean_volume": true para obtener un único valor que represente el volumen promedio del archivo de audio.

  También puedes establecerlo en false para omitir la extracción de metadatos y acelerar la transcodificación.

• user_meta

  Record<string, any>(valor predeterminado: {})

  Añade metadatos personalizados a cada archivo emitido por este Robot sin modificar el contenido del archivo.

  Los valores se combinan con los user_meta existentes en el archivo de entrada. Si ambos objetos contienen la misma clave, el valor de este Robot tiene prioridad. Se admiten Assembly Variables, por ejemplo { "internal_file_id": "${file.id}" }.

• result

  boolean(valor predeterminado: false)

  Indica si los resultados de este Step deben aparecer en el Assembly Status JSON

• queue

  batch

  Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola

• force_accept

  boolean(valor predeterminado: false)

  Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

  De forma predeterminada, los Robots ignoran los archivos que no reconocen. 🤖/video/encode, por ejemplo, ignorará sin problemas las imágenes de entrada.

  Si configuras el parámetro force_accept como true, puedes forzar a los Robots a aceptar todos los archivos que reciban. Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.

• ignore_errors

  boolean | Array<meta | execute>(valor predeterminado: [])

  Ignorar errores durante fases específicas del procesamiento.

  Establecer este parámetro en ["meta"] hará que el Robot ignore los errores durante la extracción de metadatos.

  Establecer este parámetro en ["execute"] hará que el Robot ignore los errores durante la fase principal de ejecución.

  Configurar este parámetro como true equivale a ["meta", "execute"] y hará que se ignoren los errores en ambas fases.

• use

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

  Especifica qué Step o Steps se usarán como entrada.

  • Puedes elegir cualquier nombre para los Steps, excepto ":original" (reservado para las subidas de usuarios gestionadas por Transloadit)
  • Puedes proporcionar varios Steps como entrada mediante arrays:

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

  • También puedes etiquetar los Steps de entrada con as para comunicar la intención semántica a los Robots:

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

  Consejo

  Probablemente eso sea todo lo que necesitas saber sobre use, pero puedes consultar los casos de uso avanzados.

• format

  tar | zip(valor predeterminado: "tar")

  El formato del archivo comprimido que se creará. Los valores compatibles son "tar" y "zip".

  Ten en cuenta que usar "tar" sin establecer gzip en true genera un archivo que no está comprimido de ninguna manera.

• gzip

  boolean(valor predeterminado: false)

  Determina si el archivo resultante también debe comprimirse con gzip. La compresión gzip solo se aplica si usas el formato "tar".

• password

  string | null(valor predeterminado: null)

  Esto te permite cifrar todo el contenido del archivo con una contraseña y protegerlo así contra el uso no autorizado. Para descomprimirlo, el usuario deberá proporcionar la contraseña cuando se le solicite en un campo de texto.

  Este parámetro no tiene efecto si el parámetro de formato tiene cualquier valor distinto de "zip".

• compression_level

  string | number(valor predeterminado: -6)

  Determina con qué intensidad se intenta comprimir el archivo. -0 no aplica compresión, lo que resulta adecuado para contenido multimedia que ya está comprimido. -1 es la opción más rápida y ofrece la compresión más baja. -9 es la más lenta y ofrece la compresión más alta.

  Si usas -0 en combinación con el formato tar y tienes gzip habilitado, considera configurar gzip: false en su lugar. Esto genera un archivo Tar sin formato adicional, lo que significa que ya es un archivo sin compresión.

• file_layout

  advanced | simple | relative-path(valor predeterminado: "advanced")

  Determina si el archivo resultante debe contener todos los archivos en un solo directorio (el valor para esto es "simple") o en subcarpetas según la explicación siguiente (el valor para esto es "advanced"). La opción "relative-path" conserva la estructura relativa de directorios de los archivos de entrada.

  Los archivos con el mismo nombre se numeran en la disposición de archivos "simple" para evitar conflictos de nombres.

• archive_name

  string

  El nombre del archivo comprimido que se creará (sin la extensión).

• path

  string

  La ruta en la que se colocará cada archivo dentro del archivo comprimido. Puede incluir cualquier variable de Assembly disponible. Las variables se evalúan para cada archivo, lo que permite que plantillas como "${file.meta.archive_directory}/${file.name}" conserven la estructura de directorios original de un archivo comprimido extraído previamente.

  Cuando se establece este parámetro, se ignora el parámetro file_layout.

Demos

Publicaciones relacionadas del blog