Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

HTML5 video background jQuery plugin

branch: master
README.md

jQuery Video Background plugin

Example of the jQuery Video Background plugin. Will place a resizable video in to the background of the page or designated element. Browsers that don't support the HTML5 video element will get an image if a poster image was provided.

If the containing element's width and height does not match the aspect ration of the video, the video will not stretch to fill the container but will render based on the largest dimension.

Public methods:

  • play: Trigger a play/pause event on the chosen video background. Will play if the video is already paused. Will pause if the video is already playing.
  • mute: Trigger a mute/unmute event on the chosen video background. Will unmute if the video is already muted. Will mute if the video is unmuted.
  • destroy: Will destroy the chosen video background. Will unbind events bound when the video background is initialised. Will remove HTML attached to the DOM by the plugin. If a controlPosition parameter is set this will also have to be set to safely remove all HTML elements from the DOM.
  • resize: When invoked this will resize the video background to the height of the document or window. The video background height affects the height of the document which affects the video background's ability to negatively resize.

Plugin parameters:

  • videoSource: Either an array of strings of video URL's or a two-dimensional array containing video URL's and type. No default.
  • poster: The URL string of the image used for the video poster attribute. No default.
  • autoplay: Video autoplay attribute boolean. Default is true.
  • preload: Video prelod attribute string. Default is none.
  • loop: Video loop attribute boolean. Default is false.
  • controlPosition: Position of the video controls, will append the controls to choose DOM element. Default is null. If null will append controls to the element the video background has been applied to.
  • controlText: An array of text options for the video control elements.
  • resize: Boolean which will trigger the video background to resize to match the browser height. Set to false is video background is used on another element. Default is true.
  • preloadHtml: If required, a user controlled HTML string can be injected in to the control area of the page while the video is preloading. It will be over written by the video controls when the video is ready to play.
  • preloadCallback: Allows a function to be triggered when the video preload is initiated.
  • loadedCallback: Allows a function to be triggered when the video is loaded.
  • resizeTo: Allows the video background to resize to either the document or the window. Default is document.

Video trailer from http://www.bigbuckbunny.org/, an open source http://www.blender.org/ project.

Change log

Release 1.4.0

  • Adding bower.json.

Release 1.3.1

  • Using semver.

Release 1.3.0

  • resizeTo option to control document or window height resizing.
  • Pull request #16 by Andreas Lind Petersen allowing string or array video source.

Release 1.2.0

  • Issue #12 resolved, requires videoSource to use a multi dimension array.
  • Data attributes and jQuery .data supported.
  • jQuery 1.7 support, event handlers bound with .on.
  • Public method and callback unit tests using QUnit.

Release 1.1.0

  • Update for play, mute, destroy and resize public methods.

Release 1.0.0

  • Initial release of plugin supporting a basic background video experience.

Please use the GitHub issue tracker for bug reports and feature requests.

Something went wrong with that request. Please try again.