Our /audio/artwork Robot

Extract or insert audio artwork

🤖/audio/artwork extracts the embedded cover artwork from audio files and allows you to pipe it into other Steps, for example into /image/resize Steps. It can also insert images into audio files as cover artwork.

For extraction, this Robot uses the image format embedded within the audio file — most often, this is JPEG.

If you need the image in a different format, pipe the result of this Robot into 🤖/image/resize.

The method parameter determines whether to extract or insert.

Usage example

Extract embedded cover artwork from uploaded audio files:

{
  "steps": {
    "artwork_extracted": {
      "robot": "/audio/artwork",
      "use": ":original",
      "ffmpeg_stack": "v6.0.0"
    }
  }
}

Parameters

  • use

    String / Array of Strings / Object required

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

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

  • method

    String ⋅ default: "extract"

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

  • change_format_if_necessary

    Boolean ⋅ default: false

    Whether the original file should be transcoded into a new format if there is an issue with the original file.

FFmpeg parameters

  • ffmpeg_stack

    String ⋅ default: "v5.0.0"

    Selects the FFmpeg stack version to use for encoding. These versions reflect real FFmpeg versions. We currently recommend to use "v6.0.0".

    Supported values: "v5.0.0", "v6.0.0".

    A full comparison of video presets, per stack, can be found here.

Demos

Related blog posts