Skip to content

yoheimuta/mobile-videoplayer.js

Repository files navigation

mobile-videoplayer.js

wercker status Code Climate Coverage Status Dependency Status Codacy Badge

mobile-videoplayer.js is the videoplayer for mobile browser, especially for ios safari which is disabled to autoplay mp4, inspired by jani.

Note that tamagotchi_4u.mp4 which is used to show this product demo is CC BY, belonged to BandaiJP.

Demo

Simple page to confirm basic functionality

Long scroll page to confirm autoplay and autopause

# total image file size
ls -l src/assets/tamagotchi_320x180_* | awk '{i+=$5}END{mb=(i/1000)/1000; printf "%.1fMB\n", mb}'
2.7MB

Install

Install with Bower.

bower install mobile-videoplayer.js

Setup is done.

Use bower_components/mobile-videoplayer.js/dist/mvplayer.min.*.js.

Usage

Create the container tag.

  • load-scene class element is displayed until the video is finished loading.
  • play-scene class element has one or multiple strip class elements. See Question below to understand why you must prepare multiple images to show long video.
  • replay-scene class element and done-scene class element are displayed after the video is finished playing.
  • replay-scene class element is going to be registered click event to replay the video.

Set data-*-url to send fine-grained impression trackings following VAST format as close as possible.

<div id="video_container">
  <div class="load-scene">
      <img src="http://placehold.it/320x180">
  </div>

  <div
      class="play-scene"
      data-frame-width=320
      data-frame-height=180
      data-fps=12
      data-did-start-url=""
      data-did-resume-url=""
      data-did-complete-url=""
      data-first-quartile-url=""
      data-midpoint-url=""
      data-third-quartile-url=""
      data-did-pause-url=""
      style="display: none;"
      >
      <div
          data-url="assets/tamagotchi_320x180_1.a9ac945e.jpg"
          class="strip"
          >
          <img>
      </div>
      <div
          data-url="assets/tamagotchi_320x180_2.d10717e2.jpg"
          class="strip"
          style="display: none;"
          >
          <img>
      </div>
      <div
          data-url="assets/tamagotchi_320x180_3.a6a03603.jpg"
          class="strip"
          style="display: none;"
          >
          <img>
      </div>
      <div
          data-url="assets/tamagotchi_320x180_4.0895f168.jpg"
          class="strip"
          style="display: none;"
          >
          <img>
      </div>
  </div>

  <div class="replay-scene" style="display: none;">
      <p>replay ?</p>
  </div>

  <div class="done-scene" style="display: none;">
      <img src="http://placehold.it/320x180">
  </div>
</div>

Insert the script.

Pass container element id as 1st arg and is_debug flag to console log as 2nd arg.

<script src="mvplayer.min.js"></script>
<script>
window.onload = function(){
    MVPlayer.Controller.run(document.getElementById("video_container"), true);
};
</script>

Support

Confirmed to work well in these browsers listed below.

IE6, IE7, IE8, Safari(7.1/8), Firefox(31), Chrome(39),
iOS Safari(iOS6, iOS7, iOS8), Android(2.2, 4.4, 5)

Also confirmed that time to complete loading and then start almost video is about 3~4 sec in mobile 3G network.

Namespace

mobile-videoplayer.js use only one global variable MVPlayer to avoid polluting other global namespace.

Development

Install grunt and bower commands.

sudo npm install -g grunt-cli
sudo npm install -g bower

Then install node module local dependencies.

npm install

And install bower components.

bower install

Run

grunt

Then access http://localhost:9000/ or http://localhost:9000/scroll.html.

Test

Run tests using only PhantomJS.

grunt

Run tests using FireFox, Chrome, Safari, PhantomJS and other (see Grunt.coffee).

grunt testem:run:long

Run tests to generate test coverage.

grunt testem:run:long
open coverage/lcov-report/index.html

Convert mp4 to jpgs

Use jani-strip_maker.

./bin/strip_maker from_movie_to_strips --input_file ./src/assets/tamagotchi_4u.mp4 --fps 12 --height 180 --width 320

Question

The reason why multiple images are needed is that mobile version of Safari automatically downsamples any jpg when it hits the 1024x1024 pixel limit.

  • According to Apple's Guideline about Know iOS Resource Limits, the limit about 1024 pixel seems to me not to be applied to jpg.
  • But when I tried to use an over 1024 pixel jpg in mobile version of Safari, I could confirm to be rendered a terribly coarse one.

jani-strip_maker is supported to split into multiple jpgs automatically for avoiding this limit.

Licence

Licensed under the MIT license.

About

Web video player for mobile browser, especially for ios safari which is disabled to autoplay mp4

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published