Skip to content
This repository has been archived by the owner on Jan 20, 2023. It is now read-only.

Latest commit

 

History

History
131 lines (110 loc) · 4.66 KB

README.md

File metadata and controls

131 lines (110 loc) · 4.66 KB

jquery-video

Join the chat at https://gitter.im/dachcom-digital/jquery-video Unifies the iframe APIs of Youtube, Vimeo and Dailymotion. Build as responsive jQuery UI widget.

Features

Demo

Demo can be found here: http://jquery-video.dachcom.ch/demo/

You can also checkout the project and open the index.html in the demo folder (use a webserver).

Dependencies

Installation

<!-- 1. Place containers with data attributes for configuration -->
<div class="container">
    <div class="video" data-type="vimeo" data-code="29950141" data-width="500" data-height="280"></div>
    <div class="video" data-type="youtube" data-autoplay="true" data-code="ubKinQvpc6w" data-responsive="false" data-width="960" data-height="720"></div>
    <div class="video" data-type="dailymotion" data-code="x14b8od" data-width="500" data-height="280"></div>
</div>

<!-- 2. Include libraries -->
<script src="../lib/jquery.js" type="text/javascript"></script>
<script src="../lib/jquery.ui.widget.js" type="text/javascript"></script>
<script src="../lib/froogaloop.js" type="text/javascript"></script>

<!-- 3. Include widget -->
<script src="../src/jquery.dcd.video.js" type="text/javascript"></script>

<!-- 4. Bind widget to containers -->
<script type="text/javascript">
    $(function () {
        $('.video').video();
    });
</script>

Options (data-attribute)

  • type: API used [Required:(youtube|vimeo|dailymotion)]
  • code: the video code [Required]
  • width: the width of the video [Required:Integer]
  • height: the height of the video [Required:Integer]
  • responsive: should the video be included responsively [Optional:(true|false), Default:true]
  • autoplay: should the video play automatically [Optional:(true|false), Default:false]
  • rel: should the player suggest related videos when video ends [Optional:(true|false), Default:false]

Options (Widget)

  • classResponsive: class to be used for responsive container [Optional:String, Default:"responsive"]
<script type="text/javascript">
    $(function () {
        $('.video').video({classResponsive: 'my-class'});
    });
</script>

Methods

  • play: play video
  • pause: pause video
  • stop: stop video
  • playing: returns status of video

Events

All events are available abstract and per type (e.g. videoplay, videoyoutubeplay, videovimeoplay, videodailymotionplay)

  • videoready: video is ready to play
  • videoplay: video started playing
  • videopause: video was paused
  • videoend: video was stopped or ended
<script type="text/javascript">
    $(function () {
        $('.video').on('videoready videoplay videopause videoend', function (event, data) {
            console.log(data.type);
            console.log(data.event);
        });
    });
</script>

Examples

     $(':dcd-videoYoutube').video('play'); // plays all youtube videos
     $('[data-type="youtube"]').video('play'); // plays also all youtube videos
     $('.video').video('pause'); // pauses all videos with class video
     $('[data-code="29950141"]').video('play'); // plays video with code 29950141
     $('.video').video('stop'); // stops all videos with class video
     $('[data-code="29950141"]').video('playing'); // returns true when video is playing, false if video is paused

Wishlist

  • find better way to include and initialize youtube api
  • find better way for video factory and inheritance
  • include full test suite, make events testable
  • make 'responsive' class configurable
  • find better way to stop videos for Dailymotion and Vimeo
  • implement more API commands
  • implement more APIs (Dailymotion, MyVideo, ...)
  • migrate tests to Jasmine 2.x

Known Issues

  • Youtube and Dailymotion API are throwing exceptions
  • You can't have more than one Vimeo video with the same code on one page