In addition to adjusting your video’s embed settings on site, you can add functionality to the Vimeo player by adding various URL parameters to the end of the player URL in your embed code.
URL parameters begin with a question mark (?), For example:
<iframe src="https://player.vimeo.com/video/76979871?embedparameter=value" width="640" height="360" frameborder="0" allowfullscreen></iframe>
URL parameters only apply to the specific embed code where the parameter is added.
In this article:
- Supported Player Parameters
- Using multiple embed parameters
- Applying embed parameters to Vimeo.com URL
Supported Player Parameters
Please see table below for a summary of supported player parameters.
| Parameter | Supported Values | Default Value | Description | Supported Videos |
|---|---|---|---|---|
|
autopause |
true , false OR 1,0 |
true |
The Vimeo player is designed to play only one Vimeo video at a time. Therefore, you will need to add this parameter to each video if you want to have more than one Vimeo video playing on the same page. ⚠️ Warnings: - Autopause functionality is not supported in Internet Explorer. - In order for autopause to function, you must have cookies enabled in your browser. |
All videos |
|
autoplay |
true , false OR 1,0 |
false |
Automatically start playback of the video. ⚠️ Warning: Autoplay may be blocked in some environments, such as IOS, Chrome 66+, and Safari 11+. In these cases, we’ll revert to standard playback requiring viewers to initiate playback. |
All videos |
|
background |
true , false OR 1,0 |
false |
Adding this parameter will have the following effect:
If you prefer that your video does not loop or autoplay, check out the controls=0 parameter below. Note that setting this parameter will not disable keyboard controls. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
|
byline |
true, false OR 1,0 |
Value specified |
Show the author of the video (byline). |
All videos (but only if the video owner allows) |
|
color |
[hex code] |
Vimeo blue- |
Specify the color of the video controls. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
|
colors
|
1-4 [hex codes] - comma separated. (Example: colors=000000,00adef, ffffff,000000) |
Color 1- Primary: #000000 |
Specify the colors of the player. Colors may be overridden by the embed settings of the video. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
|
controls |
true , false OR 1,0 |
true |
This parameter will hide all elements in the player (play bar, sharing buttons, etc) for a chromeless experience.
⚠️ Warnings: When using this parameter, the play/pause button will be hidden. To start playback for your viewers, you'll need to either enable autoplay, use keyboard controls, or implement our player SDK to start and control playback. Note that setting this parameter will not disable keyboard controls. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
|
dnt |
true, false OR 1,0 |
false |
Setting this parameter to "true" will block the player from tracking session data and analytics. (Will have the same effect as enabling a Do Not Track setting in your browser.) ⚠️ Warnings: When DNT is enabled, Vimeo deploys one essential cookie via the embeddable player:
|
All videos |
|
keyboard |
true, false |
true |
Allows for keyboard input to trigger player events. If false, the player will ignore keyboard input. Tabbing will still be supported in either mode. |
All videos |
|
loop |
true , false OR 1,0 |
false |
Play the video again when it reaches the end, infinitely. Note: Loop can also be chosen as a video’s end screen within the embed settings page. Learn more here. |
All videos |
|
muted |
true , false OR 1,0 |
false |
Set video to mute on load. Viewers can still adjust the volume preferences in the player. Can be used to unmute background videos, or work around autoplay limitations in certain browsers, such as Chrome and Safari. |
All videos |
|
pip
|
true, false OR 1,0 |
false |
Show the picture-in-picture button in the control bar and enable the picture-in-picture API. |
All videos |
|
playsinline |
true , false OR 1,0 |
true |
Play video inline on mobile devices instead of automatically going into fullscreen mode. Inline playback is enabled for all videos by default. |
All videos |
|
portrait |
true , false OR 1,0 |
Value specified |
Show the author’s profile image (portrait) |
All videos (but only if video owner allows) |
|
quality |
240p, 360p, 540p, 720p, 1080p, 2k, 4k |
auto |
By default, the Vimeo player is set to "Auto" mode, which means it chooses the highest video quality possible, depending on the viewer's bandwidth and other factors in the playback environment. The quality parameter allows you to specify the default playback quality for your embedded video. If you select a quality that doesn’t exist for your particular video, the quality parameter will be ignored, and the embed will default to Auto. ⚠️ Warnings: - This parameter is not supported on mobile devices or tablets. - Please use caution when implementing this parameter. Defaulting to a higher quality (like 4K) may result in excessive buffering and choppy playback for your viewers. - This parameter is only supported for uploaded videos and archived events which are embedded. It is not supported for live events. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
|
speed |
true , false OR 1,0 |
false |
Show speed controls in the preference menu of the player and enable playback rate API. (learn more about our player API at Vimeo Developer: API ) |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
|
#t |
Time represented in minutes and/or seconds (for example, #t=1m2s) |
Start of video |
Used to automatically begin playback at a specific point in time. Learn more at 'Start playback at a specific timecode'. Note: This parameter does not require a prefixed question mark as all others do. |
All videos |
|
texttrack |
a lowercase language code and optionally the locale and type of text track. (Examples: "en", "en-US", "en.captions", "en.subtitles") |
false |
Displays a given cc/subtitle track by default in the player (pending the cc/subtitle track is available).
If you enter a language preference that hasn't yet been uploaded for your particular video, the text track parameter will be ignored, and your embedded video may load with CC or subtitles disabled by default. |
All videos with captions or subtitles available (note: captions and subtitles must be uploaded by the video owner. Learn more at Captions and subtitles) |
|
title |
true, false OR 1,0 |
Value specified |
Show the video’s title. |
All videos (but only if the video owner allows) |
|
transparent |
true , false OR 1,0 |
true |
By default, the background of the player iframe is transparent on Vimeo. When disabled, the iframe background will become black. Black bars will be applied to the player when the height and width dimensions for the embedded player do not match the original aspect ratio of a video-- e.g the iframe dimensions are set to 4:3 square, but the original video is 16:9 wide. |
All videos |
|
transcript |
true , false OR 1,0
|
true |
Show the transcript button in the control bar and enable transcript controls. |
All videos with text tracks. |
Using multiple embed parameters
If you are adding multiple parameters to the same embed code, you’ll need to separate them with ampersands (&). For example:
<iframe src="https://player.vimeo.com/video/76979871?autoplay=1&loop=1&muted=1" width="640" height="360" frameborder="0"webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
Applying embed parameters to Vimeo.com URL
If you are using an application that requires you to insert a Vimeo.com URL (e.g https://vimeo.com/
For example, this method is not supported :
https://vimeo.com/76979871?
This is supported:
<iframe src="https://player.vimeo.com/video/76979871?quality=720p" width="640" height="360" frameborder="0"
webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
Some examples of applications that only support Vimeo URLs are social media posts, WordPress themes and plugins, Wix plugins, Squarespace plugins, and other miscellaneous video embed tools within webpage builders. The good news is, some tools may allow you to adjust player preferences (like autoplay, for instance) directly in their own UI.
Troubleshoot player parameters
If you are having trouble with adding a player parameter, please contact us for assistance and provide the embed code you are using for faster troubleshooting.