VjsRails
VjsRails is for using Video.js in Rails applications.
Video.js:
- version 4.9.1
- http://www.videojs.com/
Installation
Add this line to your application's Gemfile:
gem 'vjs_rails'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install vjs_rails
Usage
Add to use VjsRails asset files
In your application.js
:
# required
//= require vjs
# if you use turbolinks
//= require jquery
//= require turbolinks
//= require vjs.turbolinks
# if you want to use local flash.swf
//= require vjs.flash
# if you want to use a Japanese version
# see more: https://github.com/kouhei-fuji/vjs_rails/tree/master/vendor/assets/langs
//= require vjs.ja
In your application.css
:
/*
*= require vjs
*
* If you want to customize it, see: http://designer.videojs.com/
* you can copy and add your customized css instead of `vjs`
*
*= require my_custom_css
*/
Use VjsRails Helper
In your xxx.html.haml
:
-# sources required
= render_video_for_vjs sources: { :'video/mp4' => 'http://example.com/path/to/video.mp4', :'video/webm' => 'http://example.com/path/to/video.webm' }
-# id, class, width and height
= render_video_for_vjs id: 'my_id', :class => 'my_class', width: '640px', height: '264px'
-# captions
= render_video_for_vjs captions: { ja: { :'日本語' => 'http://example.com/path/to/ja_caption.vtt' }, en: { :'English' => 'http://example.com/path/to/en_caption.vtt' } }
-# other options
-# see more: https://github.com/videojs/video.js/blob/stable/docs/guides/options.md
= render_video_for_vjs poster: 'http://example.com/path/to/poster.png', autoplay: true
-# customize no js comment
= render_video_for_vjs sources: { :'video/mp4' => 'http://example.com/path/to/video.mp4' } do
Customize Message when js is not woking
If you don't use haml, please replace it.
Example
VjsRails provides an example rails application in spec/dummy directory.
https://github.com/kouhei-fuji/vjs_rails/tree/master/spec/dummy
$ git clone [email protected]:kouhei-fuji/vjs_rails.git
$ cd vjs_rails/spec/dummy
$ bundle install
$ bin/rails s
$ open http://localhost:3000
Contributing
- Fork it ( https://github.com/kouhei-fuji/vjs_rails/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License
VjsRails under the MIT License.