Overview

The Entreluma Vimeo Viewer adds a clean, responsive Vimeo preview to a post. Preview mode loads the video’s poster and title through Vimeo’s oEmbed service, but does not create a Vimeo player or begin playback. Clicking the preview opens the interactive player in Entreluma’s expanded dialog.

Like the YouTube viewer, Vimeo supports timed playback and action links. This is useful when a story should direct readers to a particular passage rather than the beginning of a long video.

The viewer supports both public Vimeo videos and unlisted videos that have a privacy hash.

Attributes

Required Attributes

vid

The numeric Vimeo video ID.

1

vid="19231868"

For https://vimeo.com/19231868, the ID is 19231868.

Optional Attributes

hash

The privacy hash required by an unlisted Vimeo video. For an unlisted URL such as https://vimeo.com/123456789/abc123def4, use:

1
2

vid="123456789"
hash="abc123def4"

The hash is part of the video’s access URL, so do not use this viewer to publish a video that should remain inaccessible to readers of the page.

caption

Text displayed below the video. If omitted, the title is fetched from Vimeo.

1

caption="Interview with the curator"

autoplay

Starts playback when the expanded viewer opens. Preview mode never autoplays.

1

autoplay="true"

Browser autoplay policies can still prevent automatic playback in some circumstances.

start

The initial playback position, expressed as seconds, m:ss, or h:mm:ss.

1
2
3

start="90"
start="1:30"
start="1:02:30"

end

The time at which the viewer pauses. It uses the same formats as start and must be later than the start time.

1

end="2:15"

id

A unique viewer identifier, required when an action link targets the video.

1

id="vimeo1"

aspect

The width-to-height ratio of the in-page preview. The default is 1.55.

1

aspect="1.78"

class

Size and position words such as medium right float; see Formatting Tips.

1

class="medium right"

Examples

Public Video

1
2
3
4

{% include embed/vimeo.html
    vid="19231868"
    caption="A Vimeo video"
%}

Unlisted Video

Use the video ID and privacy hash from the complete Vimeo share URL:

1
2
3
4
5

{% include embed/vimeo.html
    vid="123456789"
    hash="abc123def4"
    caption="An unlisted Vimeo video"
%}

Timed Playback

This opens at 1:30 and pauses at 2:15:

1
2
3
4
5
6

{% include embed/vimeo.html
    vid="19231868"
    autoplay="true"
    start="10"
    end="20"
%}

First give the viewer an id:

1
2
3
4

{% include embed/vimeo.html
    id="vimeo1"
    vid="19231868"
%}

Then target it from ordinary Markdown text:

1

[Play the segment](vimeo1/playat/5,10)

The playat action opens the expanded viewer, starts at 5 seconds, and pauses at 10 seconds. Vimeo also understands the play and pause actions described in the Action Links reference.

Troubleshooting

  • A Vimeo ID contains digits only. Do not paste the complete URL into vid.
  • An unlisted video must include the hash from its full share URL.
  • The video’s owner must permit embedding. Domain-restricted videos work only on approved sites.
  • Autoplay remains subject to browser policy even when autoplay="true" is present.
  • Action links require an exact matching id on the viewer.