Server Addon Vimeo

Server Addon: Vimeo

Description

Sermons hosted on Vimeo.

When to choose it: Sites wanting a clean, ad-free player. Needs a paid Vimeo plan for the API.

How to Access

Components → Proclaim → Servers → New, then choose Vimeo in the server type picker.

Note

The server type cannot be changed after the server is created. To switch platforms later, create a new server and move media across with Administration → Server Migration.

What you get at each level

Level	You supply	You get
1	Nothing	Paste a Vimeo URL; it embeds and plays
2	Access token and user ID	Browse your videos, pull metadata in, play statistics, description sync

There is no OAuth level for Vimeo. A paid Vimeo plan is required for the API, but level 1 works on any account.

Set Up the Server

Choose Vimeo, give the server a name, and Save & Close. Vimeo videos embed and play from their URL with no credentials.

Optional — add an access token

Only needed to browse your own videos from inside Proclaim and to sync metadata.

Note

The Vimeo API requires a paid Vimeo plan. Free accounts can still be embedded by URL.

1. Create an app on the Vimeo Developer portal and generate a personal access token with Authenticated access.
2. Paste it into Vimeo Access Token, and enter your Vimeo User ID.
3. Save & Close.

Step-by-step with screenshots: Vimeo-API-Setup

Add a Media File

1. Paste the Vimeo URL, or select Browse to pick from your account.
2. Set player options as you like — colour, title, byline, portrait, speed controls.
3. Save & Close.

Tip

Do Not Track (GDPR) stops Vimeo setting tracking cookies. Worth turning on if your site makes privacy commitments.

Screen Reference

Fields on the server

Field	What it is for
Vimeo Access Token	Enter your Vimeo API access token. Optional, but required for browsing your videos. Create an app on the Vimeo Developer portal to generate a token (choose “Authenticated” access).
Vimeo User ID	Your numeric Vimeo user ID. Find it in your Vimeo profile settings — it appears in the URL as vimeo.com/user12345678 or in the API response as uri: /users/12345678.
Description Format Template	Template for the video description generated by the Copy Description button. Click the placeholder badges below to insert them at the cursor. Empty placeholders are removed automatically.

Fields on a media file

Field	What it is for
URL of Vimeo Video	Use the Vimeo URL from the share section or the URL in the browser
vimeo_browse_btn	—
Muted	Start the video muted. Required for autoplay in most browsers.
Loop	Loop the video continuously.
Player Controls	Show or hide the Vimeo player controls.
Player Color	Hex color for the player controls (without #). Example: 00adef
Video Title	Show or hide the video title in the player.
Author Byline	Show or hide the author byline in the player.
Author Portrait	Show or hide the author portrait in the player.
Do Not Track (GDPR)	Enable Do Not Track mode. Prevents Vimeo from tracking the viewer. Recommended for GDPR compliance.
Background Mode	Enable background mode (no controls, auto-loop, muted). For decorative video backgrounds.
Speed Controls	Show playback speed controls.

Display settings shared by every addon

Every server type also carries the same block of display settings — player choice, popup behaviour, the media button's text, colour, icon and size, and the image shown beside it. They work the same way whichever addon you pick, and are documented on Help-server and Help-mediafile.

Related Information

• Help-server — the server form in general
• Help-servers — the servers list
• Help-mediafile — the media file form
• Guide-Add-Audio-and-Video — choosing a host and attaching media
• Server-Addons — all sixteen addons compared