Skip to content

luwes/vimeowrap.js

Repository files navigation

Deprecated!

See https://github.com/playerxo/playerx for the evolution of this project!

vimeowrap.js

vimeowrap is an easy to use Vimeo player embedder that can be extended with plugins.

Features

  • Uses oEmbed so the embed code is always up to date
  • Playlist support, play videos one after another
  • Extendable with plugins

Usage

Basic

<div id="player"></div>
<script src="https://luwes.github.io/vimeowrap.js/vimeowrap.js"></script>
<script>
	vimeowrap('player').setup({
		urls: [
			'https://vimeo.com/user3709818'
		]
	});
</script>

Carousel Plugin

<div id="player"></div>
<script src="https://luwes.github.io/vimeowrap.js/vimeowrap.js"></script>
<script src="https://luwes.github.io/vimeowrap.js/vimeowrap.carousel.js"></script>
<script>
	vimeowrap('player').setup({
		urls: [
			'https://vimeo.com/user3709818'
		],
		plugins: {
			'carousel': {}
		}
	});
</script>

Configuration

parameter default description
urls (required) Array with the Vimeo URL's. User or video URL's are supported.
width 480 Width of the Vimeo player.
height 280 Height of the Vimeo player.
autoplay false Automatically start playback of the video. Note that this won’t work on some devices.
repeat none What to do when the video has ended.
none: stop playback when a video is completed.
list: play each video in the playlist once, stop at the end.
always: continously play the video (or all videos in the playlist).
single: continously repeat the current video in the playlist.
item 0 Use this to load the player with a specific playlist item instead of the first item.
plugins Object with plugins. Plugins are seperate javascript files that extend the functionality of vimeowrap.
color 00adef Specify the color of the video controls.
byline true Show the byline on the video.
title true Show the title on the video.
portrait true Show the user's portrait on the video.

Releases

No releases published

Packages

No packages published