This project is not covered by Drupal’s security advisory policy.

When you embed a Vimeo video in Drupal using the core Media
module, Drupal talks to Vimeo through a standard called oEmbed. That standard
covers the basics, but it ignores Vimeo's own player options — the extra
settings that turn captions on, loop a video, autoplay it, or hide the title and
controls. As a result, editors paste a Vimeo URL and have no way to control how
the player behaves.

Vimeo oEmbed Attributes fills that gap. It adds dedicated fields to the media
editing form for Vimeo's player options and passes them through to Vimeo when the
video is embedded, so the rendered player honours them. Site builders choose
which options editors are allowed to set.

Features

  • Adds a "Vimeo Query String Options" section to the oEmbed video field so
    editors can set Vimeo's player parameters — captions/subtitles language
    (texttrack), looping, autoplay, background mode, muting, and player
    chrome such as the title, byline, portrait and controls colour.
  • Lets a site administrator decide which parameters appear in the editing
    form, so editors only see the options that matter to your site.
  • Stores the options inside the existing oEmbed URL field — no extra
    fields are added, and content created before installing the module keeps
    working.
  • Correctly handles Vimeo's unlisted/private video URLs (the
    vimeo.com/ID/HASH format), which standard handling mangles.

Use it whenever editors embed Vimeo videos and need control over playback or
appearance — ambient/background hero videos, autoplaying loops, forcing a
caption language for accessibility, or hiding Vimeo branding on embeds.

Post-Installation

  1. Go to Administration » Configuration » Media » Vimeo
    oEmbed Attributes
    (/admin/config/media/vimeo-oembed-attributes)
    and tick the parameters you want editors to be able to set.
  2. On the Media type used for Vimeo videos (for example "Remote video"), open
    Manage form display and set the source URL field's widget to
    oEmbed URL (with Vimeo Options).

Editors will then see the Vimeo options beneath the video URL field when they
add or edit that media. No new content type is created and no text-format changes
are needed.

Additional Requirements

None beyond Drupal core. The module requires the core Media
module and works with Drupal 10 and 11. No third-party libraries, API keys or
Vimeo accounts are required.

None required. Any module that adds or configures oEmbed-based remote video
media types pairs naturally with this one.

Similar projects

Drupal core's Media module provides the baseline Vimeo embedding that this
module extends; on its own it does not expose Vimeo's player parameters. If you
are aware of a module offering equivalent functionality, please open an issue so
this section can be updated.

Supporting this Module

Issues and merge requests are welcome in the project's issue queue.

Community Documentation

None yet.

Project information

Releases