The article explains how to customize the Vimeo player by using URL parameters in the embed code to add specific functionality to that video.
Besides adjusting your video’s embed settings on the site, you can also enhance the Vimeo player’s features by adding various URL parameters to the end of the player URL in your embed code.
URL parameters begin with a question mark (?).
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.
Supported Player Parameters
Please refer to the table below for a summary of the supported player parameters.
Parameter | Supported Values | Default Value | Description | Supported Videos |
airplay |
true, false OR 1,0 |
true | Whether AirPlay is enabled. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. ⚠️Note: AirPlay is only supported on Safari. |
ask_ai | autopause | true | Whether the Ask AI feature is enabled. | Videos hosted by an Enterprise account that are eligible for the Ask AI feature. |
audio_track |
true, false OR 1,0 |
true | Whether the audio menu appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
audiotrack |
a lowercase language code, or "main" if you want the video to default to the main audio track
|
false | Displays a given audio track by default in the player (pending the audio track is available) | All videos where multiple audio tracks have been uploaded |
autopause |
true, false OR 1,0 |
true |
The Vimeo player only plays one video at a time. To have multiple videos on the same page, you need to add a specific parameter to each one. ⚠️ Note: 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. | All videos |
background |
true, false OR 1,0 |
false |
Adding this parameter will:
To prevent looping or autoplay, use the controls=0 parameter. Setting this parameter will not disable keyboard controls. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
badge |
true, false OR 1,0 |
true | Show the video’s badge (e.g. Staff Pick badge). | All videos |
byline |
true, false OR 1,0 |
Value specified in the video’s embed settings on-site |
Show the author of the video (byline). | All videos |
cc |
true, false OR 1,0 |
true | Whether the closed captions button is enabled. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
chapters |
true, false OR 1,0 |
true | Whether the chapters button appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
chromecast |
true, false OR 1,0 |
true | Whether the Chromecast button appears. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. ⚠️Note: Chromecast is not supported on iOS |
color | [hex code] | Vimeo blue- 00adef |
Specify the color of the video controls. Colors may be overridden by the embedded settings of the video. If color is not set via parameter or setting, the transparent parameter will activate. |
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 Color 2-Accent: #00adef Color 3- Icon and text:#ffffff Color 4- Background: #000000 |
Specify the colors of the player. Colors may be overridden by the embedded 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 | Hides or reveals all player elements, such as the playbar and sharing buttons, to create a chromeless experience. Note: When enabled, the play/pause button is hidden. Viewers must use autoplay, keyboard controls, or our player SDK to start and control playback. This setting does 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" blocks the player from collecting session data and analytics, similar to activating a Do Not Track feature in your browser. ⚠️ Note: With DNT active, some essential cookies will still be active. Visit Vimeo Player Cookies to view this list. |
All videos |
fullscreen |
true, false OR 1,0 |
true | Whether the fullscreen button appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
initial_quality | 240p, 360p, 540p, 720p, 1080p, 2k, 4k | auto |
The initial video quality, shown briefly before adaptive streaming starts. This is adjustable for faster loading or better clarity. Lower quality, like 360p, loads faster; higher quality, like 1080p or 4K, offers better resolution immediately. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
interactive_params | Comma separated key-value pairs | None | Key-value pairs representing dynamic parameters that are utilized on interactive videos with dynamic elements, such as title=my-video , subtitle=interactive | Interactive videos |
interactive_markers |
true, false OR 1,0 |
true | Whether to display markers representing the timestamp where hotspots appear on an interactive video. | Interacive videos |
keyboard |
true, false OR 1,0 |
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. 💡Tip: The loop option can also be selected as a video’s end screen within the embed settings page. Read more at About end screens. |
All videos |
max_quality | 240p, 360p, 540p, 720p, 1080p, 2k, 4k | auto |
The highest quality the player will automatically select during video playback. The player chooses the best quality up to this value without exceeding it. Setting this can help reduce bandwidth consumption. You can select any value from the quality menu in the video player, including 360p, 720p, 1080p, 2K, and 4K. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
min_quality | 240p, 360p, 540p, 720p, 1080p, 2k, 4k | auto |
The lowest quality the player will automatically switch to during video playback. The player selects the optimal quality without falling below this threshold. Setting this parameter helps ensure viewers receive high-resolution video while considering bandwidth constraints. You can select any quality option available in the player, including 360p, 720p, 1080p, 2K, and 4K. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
muted |
true, false OR 1,0 |
false |
Set the 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. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account |
play_button_position | auto, bottom, or center | auto | Where the play button is positioned on the player. When set to auto, the play button appears in the control bar before moving to the center of the player on smaller breakpoints. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account |
playsinline |
true, false OR 1,0 |
true | Play video inline on mobile devices instead of automatically going into full-screen mode. Inline playback is enabled by default for all videos. | All videos |
portrait |
true, false OR 1,0 |
Value specified in the video’s embed settings on site |
Show the author’s profile image (portrait). | All videos |
preload | metadata, metadata_on_hover, auto, auto_on_hover, none |
metadata_ on_hover |
The player's pre-playback loading behavior aligns with the native preload property of the HTMLMediaElement interface, with some added options:
Preloading more data helps the video start faster. Therefore, "auto" and "auto_on_hover" lead to quicker startup, but they require more bandwidth since video segments load whether the user plays the video or not. For more details on Vimeo’s bandwidth limits, visit Bandwidth on Vimeo. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
progress_bar |
true, false OR 1,0 |
true | Whether the progress bar appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
quality | 240p, 360p, 540p, 720p, 1080p, 2k, 4k | auto |
By default, the Vimeo player is set to "Auto" mode, meaning it chooses the highest possible video quality based on the viewer's bandwidth and other factors in the playback environment. Quality lets you specify the default playback resolution for your embedded video. If you select a quality that isn’t available, the parameter will be ignored, and the embed will default to Auto. 💡Tip: Choosing a higher quality setting (like 4K) might lead to excessive buffering and choppy playback for viewers. |
Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. Available for uploaded videos and archived events. It doesn't support live events. |
quality_selector |
true, false OR 1,0 |
true | Whether the quality selector menu appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
skipping_forward |
true, false OR 1,0 |
true | Whether the user is allowed to skip forward during playback. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
speed |
true, false OR 1,0 |
false | Display speed controls in the player's preference menu and enable the playback rate API. (read 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 (0m) |
Used to automatically begin playback at a specific point in time. Learn how at 'Start playback at a specific timecode'. 💡Tip: 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 specified cc/subtitle track by default in the player, if available. If you select a language preference that hasn't yet been uploaded for your video, the text track setting will be ignored, and the embedded video may load with captions or subtitles turned off by default. |
All videos with captions or subtitles are available (note: captions and subtitles must be uploaded by the video owner. Read more at Captions and subtitles) |
thumbnail_id | The ID of the thumbnail to load from the video’s available thumbnail set. | None | Displays the ID of the thumbnail to load from the video's available thumbnail set. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
title |
true, false OR 1,0 |
Value specified in the video’s embed settings on site |
Show the video’s title. | All videos |
transparent |
true, false OR 1,0 |
true |
The transparent setting is active if the color hasn't been specified via a setting or parameter. Typically, the Vimeo player's iframe background is transparent by default. If disabled, the background will change to black. Black bars will be visible on the player when the iframe's height and width don't match the video's original aspect ratio, such as setting the iframe to 4:3 while the original video is 16:9. |
All videos |
transcript |
true, false OR 1,0
|
true | Show the transcript button in the control bar and enable transcript controls. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
unmute_button |
true, false OR 1,0 |
true | Whether the unmute button appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
vimeo_logo |
true, false OR 1,0 |
true | Whether the Vimeo logo appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
volume |
true, false OR 1,0 |
true | Whether the volume control appears. | Video must be hosted by a Starter, Standard, Advanced, Plus, Pro, Business, Premium, or Enterprise account. |
watch_full_video |
true, false OR 1,0 |
true | Whether the Watch Full Video button appears on videos in Segmented Playback mode. | All videos in Segmented Playback mode. |