Extract or insert video artwork

Usage example

{
  "steps": {
    "artwork_extracted": {
      "robot": "/video/artwork",
      "use": ":original",
      "ffmpeg_stack": "v6"
    }
  }
}

Parameters

• interpolate

  boolean | Record<string, boolean>

• output_meta

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

• result

  boolean (default: false)

• queue

  batch

• force_accept

  boolean (default: false)

• ignore_errors

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

• use

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

• ffmpeg

  object

• ffmpeg_stack

  v6 | v7 | v8 | string (default: "v6.0.0")

• preset

  aac | alac | audio/aac | audio/alac | audio/flac | audio/mp3 | audio/ogg | rKMa06

• method

  extract | insert (default: "extract")

This Robot extracts or inserts cover artwork in video files.

For extraction, it uses the image format embedded within the video file — most often, this is JPEG. If you need the image in a different format, pipe the result into 🤖/image/resize.

For insertion, provide both a video file (as "video") and an image file (as "image") via the use parameter, and set method to "insert". The image will be embedded as the cover artwork of the video file.

Extract embedded cover artwork from uploaded video files:

Controls whether Assembly Variables are interpolated for individual instruction fields.

By default, most Robot instruction fields interpolate Assembly Variables. Set this to false to treat every instruction field as literal text, or set an individual field path to false to treat only that field as literal text. For Robot-specific fields that are literal by default, set this to true or set that field path to true to opt back into interpolation.

Use field names such as path, or dotted paths such as ffmpeg.vf for nested objects.

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

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 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.

Ignore errors during specific phases of processing.

Setting this to ["meta"] will cause the Robot to ignore errors during metadata extraction.

Setting this to ["execute"] will cause the Robot to ignore errors during the main execution phase.

Setting this to true is equivalent to ["meta", "execute"] and will ignore errors in both phases.

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"
    ]
  }
  

• You can also tag input Steps with as to pass semantic intent to robots:
  

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

A parameter object to be passed to FFmpeg. If a preset is used, the options specified are merged on top of the ones from the preset. For available options, see the FFmpeg documentation. Options specified here take precedence over the preset options.

Selects the FFmpeg stack version to use for encoding. These versions reflect real FFmpeg versions. We currently recommend to use "v6.0.0". Deprecated "v5.x" values are accepted for backward compatibility.

What should be done with the video file. A value of "extract" means video artwork will be extracted. A value of "insert" means the provided image will be inserted as video artwork.

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 images, you can also add "blurhash": true to extract a BlurHash string — a compact representation of a placeholder for the image, useful for showing a blurred preview while the full image loads.

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

For videos, you can also add "interlaced": true to detect whether the video is interlaced. This combines the cheap ffprobe field_order flag with a bounded idet sampling pass over the first frames of the source, exposing interlaced, field_order, and a diagnostic interlace_detection object under file.meta. This is computationally expensive and billed accordingly.

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.

Performs conversion using pre-configured settings.

If you specify your own FFmpeg parameters using the Robot's ffmpeg parameter and you have not specified a preset, then the default mp3 preset is not applied. This is to prevent you from having to override each of the MP3 preset's values manually.

For a list of audio presets, see audio presets.