Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.06 KB

README.md

File metadata and controls

82 lines (53 loc) · 2.06 KB

jQuery.BackgroundVideo V 1.0

Inspired by [Tubular] (http://www.seanmccambridge.com/tubular/)

EXAMPLE: http://rochestb.github.io/jQuery.YoutubeBackground/

jQuery plugin that lets you create background videos using youtube api

Put the script at the bottom of your markup right after jQuery:

 <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
 <script src="src/jquery.youtubebackground.js"></script>
<div id="video"></div>

Call the plugin function and your carousel is ready.

$('#video').YTPlayer({
    fitToBackground: true,
    videoId: 'LSmgKRx5pBo'
});

Works with Youtube Javascript API

Youtube Javascript API Options

 Access all of YouTube API of player:

 var player = $('#video').data('ytPlayer').getPlayer();
 player.pauseVideo();
 player.mute()

Options

  ratio: 16 / 9, // change as needed
  videoId: 'LSmgKRx5pBo'
  mute: true,
  repeat: true,
  fitToBackground: true

Install with Bower

bower install youtube-background-video

Documentation

None yet

Contributing

I welcome contributors, bugs, and questions.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest develop branch in the repository.

  3. Isolate the problem — ideally create a reduced test case and a live example. This JSFiddle is a helpful template you can fork.

By submitting a patch, you agree to allow the project owner to license your work under the terms of the MIT License.

License

The code and the documentation are released under the MIT License.