Permalink
6f85448 Feb 24, 2017
@ron666 @xpetter @DmitryKrekota @denismosolov
239 lines (183 sloc) 9.74 KB

Installation

0. Setup MIME-types (optional)

On Linux/Apache servers, create a file called .htaccess with the following text and upload it to the root of your website

# Video support
AddType video/ogg .ogv
AddType video/mp4 .mp4
AddType video/webm .webm
AddType video/ogv .ogv

# Audio support
AddType audio/mp3 .mp3
AddType audio/oga .oga
AddType audio/ogg .ogg
AddType audio/wav .wav

# For HLS support
AddType application/x-mpegURL .m3u8
AddType vnd.apple.mpegURL .m3u8
AddType video/MP2T .ts

# For M(PEG)-DASH support
AddType application/dash+xml .mpd

# For subtitles support
AddType text/vtt .vtt
AddType text/srt .srt

On Windows/IIS servers, please follow Microsoft's instructions on how to add/edit MIME types on IIS6 and IIS7.

If you are working with local files and plan to test Flash playback, make sure you go to the Flash Security Settings page and add your working directory. Also, things tend to work best when you use absolute paths.

If you want to make your media to play in Chromium browser, please read this document

For more information about how to set up a server to serve media properly and other general and useful topics about dealing with HTML5 video, this article is a good start point.

Do not compress media (mod_deflate or gzip), since it can lead to unexpected results, like headers not being passed correctly.

1. Install MediaElementJS

To get the default installation there are several different ways.

  1. Download the package from https://github.com/johndyer/mediaelement

  2. Use a CDN reference; the most popular ones are jsDelivr and cdnjs.

  3. Through GIT: git clone https://github.com/johndyer/mediaelement.git

  4. Through NPM: npm install mediaelement

  5. If you are using Meteor: meteor add johndyer:mediaelement or meteor npm install mediaelement

However, MediaElementJS has additional features for the player, such as VAST, Google Analytics, etc.

If you want to install any of them, refer to the new plugins repository clicking here for more information.

2. Add Script and Stylesheet

<script src="/path/to/jquery.js"></script>
<script src="/path/to/mediaelement-and-player.min.js"></script>
<link rel="stylesheet" href="/path/to/mediaelementplayer.min.css" />

If you wish to install the sources in different directories (i.e., all Javascript files in a js, all CSS in a styles, Flash shims in plugins, etc.), add the following CSS update after the mediaelementplayer.css reference (only if the images are not in the same folder as the stylesheet):

<link rel="stylesheet" href="/path/to/mediaelementplayer.min.css" />

<style>
.mejs__overlay-button {
    background: url("/path/to/mejs-controls.svg") no-repeat;
}
.mejs__overlay-loading-bg-img {
    background: transparent url("/path/to/mejs-controls.svg") -160px -40px no-repeat;
}
.mejs__button > button {
    background: transparent url("/path/to/mejs-controls.svg") no-repeat;
}
</style>

Also, update pluginPath within the configuration options (visit Usage and Tips and API and Configuration for more details) with the location of the Flash shims.

You can also use a CDN to load your script and stylesheet.

As stated above, the important factor is to set the pluginPath correctly, but also, for this scenario, you will need to set the shimScriptAccess configuration element as always to make the shims to work.

As an example:

$('video, audio').mediaelementplayer({
    // Do not forget to put a final slash (/)
    pluginPath: 'https://cdnjs.com/libraries/mediaelement/',
    // this will allow the CDN to use Flash without restrictions 
    // (by default, this is set as `sameDomain`)
    shimScriptAccess: 'always' 
    // more configuration
});

3. Add <video> or <audio> tags

Default setup

If your users have JavaScript and/or Flash, the easiest route for all browsers and mobile devices is to use a single file.

<video src="myvideo.mp4" width="320" height="240" type="video/mp4"></video>

or

<video width="320" height="240">
    <source type="video/mp4" src="myvideo.mp4" />
</video>

All the formats listed in Browser and Device support can be instantiated using this setup.

Note: Although it is important to include their MIME type so the plugin renders the media accurately, some browsers like Firefox can display errors in regards of unknown/custom MIME types. But they don't prevent the plugin to work properly.

Multiple codecs (Optional)

This includes multiple codecs for various browsers (H.264 for IE9+, Safari, and Chrome, WebM for Firefox 4 and Opera, Ogg for Firefox 3).

<video width="320" height="240" poster="poster.jpg" controls="controls" preload="none">
    <source type="video/mp4" src="myvideo.mp4" />
    <source type="video/webm" src="myvideo.webm" />
    <source type="video/ogg" src="myvideo.ogv" />
</video>

Browsers with JavaScript disabled (Optional)

In very rare cases, you might have a non-HTML5 browser with Flash turned on and JavaScript turned off. In that specific case, you can also include the Flash <object> code. For more information abput this approach, please read Video for Everybody! documentation.

<video width="320" height="240" poster="poster.jpg" controls="controls" preload="none">
    <source type="video/mp4" src="myvideo.mp4" />
    <source type="video/webm" src="myvideo.webm" />
    <source type="video/ogg" src="myvideo.ogv" />
    <object width="320" height="240" type="application/x-shockwave-flash" data="/path/to/mediaelement-flash-video.swf">
        <param name="movie" value="/path/to/mediaelement-flash-video.swf" /> 
        <param name="flashvars" value="controls=true&amp;poster=myvideo.jpg&amp;file=myvideo.mp4" />        
        <img src="myvideo.jpg" width="320" height="240" title="No video playback capabilities" />
    </object>
</video>

If you plan to use this approach, just remember that it will only work for native media types, and you can use mediaelement-flash-audio.swf (MP3), mediaelement-flash-audio-ogg.swf (OGA) or mediaelement-flash-video.swf (MP4, FLV, RTMP, M4V, etc.) shims for it.

Use of Closed Captioning (Optional)

The way to setup closed captioning is by using the track tag as follows:

<video width="320" height="240" poster="poster.jpg" controls="controls" preload="none">
    <source type="video/mp4" src="myvideo.mp4" />
    ... 
    <track src="subtitles_en.[srt|vtt]" kind="[subtitles|captions|chapters]" srclang="en" label="English">
    <track src="subtitles_es.[srt|vtt]" kind="[subtitles|captions|chapters]" srclang="es" label="Spanish">
    ...
</video>

This works perfectly on any browser that supports HTML5 natively; however, to make this work across browsers, an AJAX request is performed to parse the content of the subtitles file.

That's why is important to put the caption files in the same domain as the player is. Otherwise, the request of the file will be denied.

As a final note, to display closed captioning in iOS, they will need to be transcoded it in the video. To learn more about this topic, please read The Zencoder guide to closed captioning for web, mobile, and connected TV.

4. Set default language (Optional)

By default, all the strings in MediaElementJS are in English. If you wanna set a different language for them, you need to set the language code via mejs.i18n.locale.language before the player instantiation, and specify the language in the media container in the success callback.

Optionally, just can set the attribute lang in the <html> tag with the one you set before, to declare the default language of the text in the rest of the page as well.

<script>

    mejs.i18n.language('de'); // Setting German language

    $('audio,video').mediaelementplayer({
        success: function(player, node) {

            // Optional
            $(player).closest('.mejs__container').attr('lang', mejs.i18n.language());

            $('html').attr('lang', mejs.i18n.language());

            // More code
        }
    });
</script>

Available languages:

  • Catalan (ca)
  • Czech (cs)
  • German (de)
  • English (en)
  • Spanish; Castilian (es)
  • French (fr)
  • Hungarian (hu)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Dutch (nl)
  • Polish (pl)
  • Portuguese (pt)
  • Brazilian Portuguese (pt-BR)
  • Romanian (ro)
  • Russian (ru)
  • Slovak (sk)
  • Swedish (sv)
  • Ukrainian (uk)
  • Simplified Chinese (zh-CN)
  • Traditional Chinese (zh-TW)

Back to Main