Easy as hell jQuery plugin for video backgrounds.
npm install vide
Vide
====
Easy as hell jQuery plugin for video backgrounds.
* All modern desktop browsers are supported.
* IE9+
* iOS plays video from a browser only in the native player. So video for iOS is disabled, only fullscreen poster will be used.
* Some android devices play video, some not — go figure. So video for android is disabled, only fullscreen poster will be used.
Download it from GitHub or via Bower:bower install vide
Include plugin:
Prepare your video in several formats like '.webm', '.mp4' for cross browser compatibility, also add a poster with .jpg, .png or .gif extension:
``
path/
├── to/
│ ├── video.mp4
│ ├── video.ogv
│ ├── video.webm
│ └── video.jpg
Add data-vide-bg attribute with a path to the video and poster without extension, video and poster must have the same name. Add data-vide-options to pass vide options, if you need it. By default video is muted, looped and starts automatically.`html
data-vide-bg="path/to/video" data-vide-options="loop: false, muted: false, position: 0% 0%">
Also you can set extended path:
html
data-vide-bg="mp4: path/to/video1, webm: path/to/video2, ogv: path/to/video3, poster: path/to/poster"
data-vide-options="posterType: jpg, loop: false, muted: false, position: 0% 0%">
In some situations it can be helpful to initialize it with JS because Vide doesn't have mutation observers:
js
$('#myBlock').vide('path/to/video');
$('#myBlock').vide('path/to/video', {
...options...
});
$('#myBlock').vide({
mp4: path/to/video1,
webm: path/to/video2,
ogv: path/to/video3,
poster: path/to/poster
}, {
...options...
});
$('#myBlock').vide('extended path as a string', 'options as a string');
`Easy as hell.
Options
Below is a complete list of options and matching default values:
js
{
volume: 1,
playbackRate: 1,
muted: true,
loop: true,
autoplay: true,
position: '50% 50%', // Similar to the CSS background-position property.
posterType: 'detect', // Poster image type. "detect" — auto-detection; "none" — no poster; "jpg", "png", "gif",... - extensions.
resizing: true, // Auto-resizing, read: https://github.com/VodkaBears/Vide#resizing
bgColor: 'transparent', // Allow custom background-color for Vide div,
className: '' // Add custom CSS class to Vide div
}
`Methods
Below is a complete list of methods:
js
// Get instance of the plugin
var instance = $('#yourElement').data('vide');// Get video element of the background. Do what you want.
instance.getVideoObject();
// Resize video background.
// It calls automatically, if window resize (or element, if you will use something like https://github.com/cowboy/jquery-resize).
instance.resize();
// Destroy plugin instance
instance.destroy();
`Resizing
The Vide plugin resizes if the window resizes. If you will use something like https://github.com/cowboy/jquery-resize, it will resize automatically when the container resizes. Or simply use
method whenever you need.Set the
resizing option to false to disable auto-resizing.Encoding video
http://diveintohtml5.info/video.html#miro
Meteor
$3
`sh
meteor add vodkabears:vide
`$3
Because of how meteor renders templates reactively you will need to initialize
manually for the templates you want to use vide in.
js
Template.templateName.onRendered(function() {
this.$('#elementName').vide('fileNameWithoutExtension');
});
`Meteor integration by zimme.
Ruby Gem
Vider by Islam Wazery.
License
The MIT License (MIT)Copyright (c) 2015 Ilya Makarov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.