Compress files

Usage example

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

Parameters

• output_meta

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

  Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

  For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.

  For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

  For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.

  You can also set this to false to skip metadata extraction and speed up transcoding.

• result

  boolean (default: false)

  Whether the results of this Step should be present in the Assembly Status JSON

• queue

  batch

  Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

• force_accept

  boolean (default: false)

  Force a Robot to accept a file type it would have ignored.

  By default, Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.

  With the force_accept parameter set to true, you can force Robots to accept all files thrown at them. This will typically lead to errors and should only be used for debugging or combatting edge cases.

• use

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

  Specifies which Step(s) to use as input.

  • You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)
  • You can provide several Steps as input with arrays:
    

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

  Tip

  That's likely all you need to know about use, but you can view Advanced use cases.

• format

  tar | zip (default: "tar")

  The format of the archive to be created. Supported values are "tar" and "zip".

  Note that "tar" without setting gzip to true results in an archive that's not compressed in any way.

• gzip

  boolean (default: false)

  Determines if the result archive should also be gzipped. Gzip compression is only applied if you use the "tar" format.

• password

  string | null (default: null)

  This allows you to encrypt all archive contents with a password and thereby protect it against unauthorized use. To unzip the archive, the user will need to provide the password in a text input field prompt.

  This parameter has no effect if the format parameter is anything other than "zip".

• compression_level

  string | number (default: -6)

  Determines how fiercely to try to compress the archive. -0 is compressionless, which is suitable for media that is already compressed. -1 is fastest with lowest compression. -9 is slowest with the highest compression.

  If you are using -0 in combination with the tar format with gzip enabled, consider setting gzip: false instead. This results in a plain Tar archive, meaning it already has no compression.

• file_layout

  advanced | simple | relative-path (default: "advanced")

  Determines if the result archive should contain all files in one directory (value for this is "simple") or in subfolders according to the explanation below (value for this is "advanced"). The "relative-path" option preserves the relative directory structure of the input files.

  Files with same names are numbered in the "simple" file layout to avoid naming collisions.

• archive_name

  string

  The name of the archive file to be created (without the file extension).

Demos

Related blog posts