Thumbnail Enricher

Thumbnail Enricher#

Module type

enricher

Generates thumbnails for video files to provide visual previews.

Features#

  • Processes video files and generates evenly distributed thumbnails.

  • Calculates the number of thumbnails based on video duration, thumbnails_per_minute, and max_thumbnails.

  • Distributes thumbnails equally across the video’s duration and stores them as media objects.

  • Adds metadata for each thumbnail, including timestamps and IDs.

Notes#

  • Requires ffmpeg to be installed and accessible via the system’s PATH.

  • Handles videos without pre-existing duration metadata by probing with ffmpeg.

  • Skips enrichment for non-video media files.

Configuration Options#

YAML#

# steps configuration
steps:
...
  enrichers:
  - thumbnail_enricher
...

# module configuration
...

thumbnail_enricher:
  thumbnails_per_minute: 60
  max_thumbnails: 16

Command Line:#

Option

Description

Default

Type

thumbnail_enricher.thumbnails_per_minute

Optional. how many thumbnails to generate per minute of video, can be limited by max_thumbnails

60

int

thumbnail_enricher.max_thumbnails

Optional. limit the number of thumbnails to generate per video, 0 means no limit

16

int

API Reference

Contents