vimeoEmbedder.js

Embed and extend the customization of the Vimeo player beyond its native abilities.

Latest version: 1.0 (August 10, 2013)

vimeoEmbedder.js for jQuery helps artists and designers present their Vimeo videos on websites the way they want them to.

Overview

vimeoEmbedder.js for jQuery helps you easily embed and extend the customization of the Vimeo player beyond its native abilities. The lightweight plugin is designed to help give you creative control over how your Vimeo videos are presented by configuring a set of options. In addition, vimeoEmbedder.js enables you to customize your own placeholder image for any Vimeo video. The plugin does not embed Vimeo videos when a web page loads on the fly, but rather allows the user to embed the video player on click.

Configuration Options

vimeoID

Input the Video ID that is assigned to your video file at Vimeo.com. (copy the URL or ID from your web browser’s address bar while viewing the video on Vimeo.)

width

Width of the player in pixels (defaults to 480 pixels).

height

Height of the player in pixels (defaults to 270 pixels).

vimeoColor

Changes the color scheme of the Vimeo player (including play button, progress bar and volume levels).

image

URL to a JPG/PNG poster image to display before the Vimeo video is loaded and playback is started.

playButtonColor

Sets the background color of the poster image play button.

vimeoBackground

Assign a background color for the Vimeo player.

Usage and Options

1) To use vimeoEmbedder.js, the first thing you should do is load the scripts and stylesheet found in the distribution within the head tag:


            <link rel="stylesheet" href="css/vimeoEmbedder.css">
            
            <script type="text/javascript" src="js/jquery-1.10.2.min.js"></script>

            <script type="text/javascript" src="js/jquery.vimeoEmbedder.js"></script>

2) Next, place the following source code anywhere inside the body tag of your HTML document where you would like the Vimeo player to be displayed:


            <div id="vimeoEmbedder"></div>

3) Customize and style the Vimeo player configuration options inside the jquery.vimeoEmbedder.js javascript file.

Browsers and platforms

vimeoEmbedder.js works reliably on Firefox, Safari, Chrome and IE.

Demo

The above Vimeo player uses the following vimeoEmbedder.js configuration options:


            var vimeoID = "1185749";

var width = "480";

var height = "270";

var image = "/vimeoembedder/plugin/img/cover.jpg";

var vimeoColor = "88d6f6";

var playButtonColor= "88d6f6";

var vimeoBgColor = "f1f1f1";