mediaelement
Version:
One file. Any browser. Same UI.
94 lines (60 loc) • 4.43 kB
Markdown
# 
One file. Any browser. Same UI.
* Author: John Dyer [http://j.hn/](http://j.hn/)
* Website: [http://mediaelementjs.com/](http://mediaelementjs.com/)
* License: [MIT](http://mediaelement.mit-license.org/)
* Meaning: Use everywhere, keep copyright, it'd be swell if you'd link back here.
* Thanks: my employer, [Dallas Theological Seminary](http://www.dts.edu/)
* Contributors: [all contributors](https://github.com/mediaelement/mediaelement/graphs/contributors)
[](https://github.com/mediaelement/mediaelement)
[](https://travis-ci.org/mediaelement/mediaelement)
[](https://coveralls.io/github/mediaelement/mediaelement)
[](https://mediaelement.mit-license.org/)
[](https://cdnjs.com/libraries/mediaelement)
[](https://www.jsdelivr.com/package/npm/mediaelement)
# Table of Contents
* [Introduction](#intro)
* [Installation and Usage](#installation)
* [API and Configuration](#api)
* [Guidelines for Contributors](#guidelines)
* [Change Log](#changelog)
* [Migration](#migration)
* [TODO list](#todo)
<a id="intro"></a>
## Introduction
_MediaElementPlayer: HTML5 `<video>` and `<audio>` player_
A complete HTML/CSS audio/video player built on top `MediaElement.js`. Many great HTML5 players have a completely separate Flash UI in fallback mode, but MediaElementPlayer.js uses the same HTML/CSS for all players.
`MediaElement.js` is a set of custom Flash plugins that mimic the HTML5 MediaElement API for browsers that don't support HTML5 or don't support the media codecs you're using.
Instead of using Flash as a _fallback_, Flash is used to make the browser seem HTML5 compliant and enable codecs like H.264 (via Flash) on all browsers.
In general, `MediaElement.js` supports **IE11+, MS Edge, Chrome, Firefox, Safari, iOS 8+** and **Android 4.0+**.
**It is strongly recommended to read the entire documentation and check the `demo` folder to get the most out of this package**. Visit [here](docs) to start.
## * IMPORTANT NOTE for Safari users (Jun 8, 2017)
Since Sierra version, `autoplay` policies have changed. You may experience an error if you try to execute `play` programmatically or via `autoplay` attribute with MediaElement, unless `muted` attribute is specified.
For more information, read https://webkit.org/blog/7734/auto-play-policy-changes-for-macos/
<a id="installation"></a>
## Installation and Usage
The full documentation on how to install `MediaElement.js` is available at [Installation](docs/installation.md).
A brief guide on how to create and use instances of `MediaElement` available at [Usage](docs/usage.md).
Additional features can be found at https://github.com/mediaelement/mediaelement-plugins.
<a id="api"></a>
## API and Configuration
`MediaElement.js` has many options that you can take advantage from. Visit [API and Configuration](docs/api.md) for more details.
Also, a `Utilities/Features` guide is available for development. Visit [Utilities/Features](docs/utils.md) for more details.
<a id="guidelines"></a>
## Guidelines for Contributors
If you want to contribute to improve this package, please read [Guidelines](docs/guidelines.md).
**NOTE**: If you would like to contribute with translations, make sure that you also check https://github.com/mediaelement/mediaelement-plugins, and perform the
translations for the files suffixed as `-i18n`.
<a id="sources"></a>
## Useful resources
A compilation of useful articles can be found [here](docs/resources.md).
<a id="changelog"></a>
## Change Log
Changes available at [Change Log](changelog.md).
<a id="migration"></a>
## Migration
For migrating mediaelement see [Migration guide](MIGRATION.md).
<a id="todo"></a>
## TODO list
**IMPORTANT:** Before posting an issue, it is strongly encouraged to read the whole documentation since it covers the majority of scenarios exposed in prior issues.
New features and pending bugs can be found at [TODO list](TODO.md).