Generate static thumbnails and animations

Every outputs must be set inside the outputs key with each value being a Hash describing the output format and settings.

The format specs are named following a very simple naming convention described in the Formats page.

Examples

Generating thumbnails in JPG formats and a very cool WebP animation with multiple scenes:

{
  "outputs": {
    "jpg:480x": {
      "key": "jpg:medium",
      "path": "/jpg/medium/thumbs_%05d.jpg",
      "number": 10
    },
    "jpg:120x": {
      "key": "jpg:tooltip",
      "path": "/jpg/tooltip/image.jpg",
      "interval": 10,
      "sprite": {
        "columns": 10,
        "limit": 100
      },
      "vtt": {
        "filename": "thumbs.vtt"
      }
    },
    "webp_anim:320x320": {
      "key": "webp:preview",
      "path": "/webp/preview.webp",
      "scene": {
        "number": 5,
        "duration": 1
      },
      "square": true
    }
  }
}

Parameters

Static thumbnails in JPG, PNG and WebP format

*Simple Format pattern: jpg|png|webp:$widthx$height*

Generate thumbnails in either jpg, png or webp format from the source video.

Example

{
  "outputs": {
    "jpg:240x": {
      "key": "jpg:small",
      "path": "/jpg/small/thumbs_%05d.jpg",
      "number": 10
    },
    "jpg:480x": {
      "key": "jpg:medium",
      "path": "/jpg/medium/thumbs_%05d.jpg",
      "number": 10
    },
    "webp:960x": {
      "key": "webp:large",
      "path": "/webp/large/thumbs_%05d.webp",
      "number": 10
    },
    "jpg:400x400": {
      "key": "jpg:square",
      "path": "/jpg/square/image.jpg",
      "square": true
    }
  }
}

3 ways to generate thumbnails

number

By using the number option which is the default, you choose to generate a given number of thumbnails. The images will be spaced equally.

Example:

{
  "outputs": {
    "jpg:240x": {
      "path": "/jpg/thumbs_%05d.jpg",
      "number": 20
    }
  }
}

offsets

By using offsets (Array), you specifically select 1 or many offsets in second where you want to take the thumbnail.

Example:

{
  "outputs": {
    "jpg:480x": {
      "path": "/jpg/thumbs_%05d.jpg",
      "offsets": [1, 10, 30, 50, 100]
    }
  }
}

interval

With interval, you specify an interval in seconds.

Example generating multiple sprite files and a VTT file:

{
  "outputs": {
    "webp:200x": {
      "path": "/webp/thumbs_%05d.webp",
      "interval": 10,
      "sprite": {
        "columns": 10,
        "limit": 100
      },
      "vtt": {
        "filename": "thumbs.vtt"
      }
    }
  }
}

Static Images Parameters

Animation [ UNIMPLIMENTED ]

*Simple Format pattern: gif|webp_anim:$widthx$height*

Create an animation image from the source video. Width must be <= 600px.

Example

{
  "outputs": {
    "webp_anim:480x": {
      "key": "webp:animation",
      "path": "/webp/animation.webp",
      "scene": {
        "number:" 5,
        "duration": 1
      }
    }
  }
}

The height is automatically calculated according to the given width and the original aspect ratio.

Animation Parameters