Files
ArtPlayer/README.md
T
2021-11-28 10:09:23 +08:00

2.8 KiB

ArtPlayer.js

🎨 ArtPlayer.js is a modern and full featured HTML5 video player

Build Status Downloads Version License

・ Online Editor ・ API Document ・

screenshot

Features

  • Size - 27kB minified and gzipped
  • Subtitle - Support for .VTT, .ASS and .SRT formats
  • Customizable - Right Click Menu, Business Layer, Video Controller and Settings Panel
  • Controller - Quality Switch, Subtitle Switch, Play Speed, Aspect Ratio, Video Flip, Fullscreen, Picture In Picture, Screenshot, Thumbnail, Adaptive Size, Highlight and Hotkey...
  • Built-in - Open Local Subtitles, Open Local Video, Mini Progress Bar, Network Detection and Subtitle Time Offset
  • Integration - Easy to integration with other dependencies: flv.js, hls.js, dash.js, shaka-player, webtorrent...
  • Code - Vanilla ES6 and SASS, Highly decoupled code, clear structure, easy to track bugs and add new features
  • Document - Detailed interface documentation and rich code demo
  • API - Rich interface and response events, easy to interface with business or custom plugin
  • I18N - support for internationalization of controls

Install

Install with npm:

$ npm install artplayer

Or install with yarn:

$ yarn add artplayer
import Artplayer from 'artplayer';

Or umd builds are also available:

<script src="path/to/artplayer.js"></script>

Or from jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/artplayer/dist/artplayer.js"></script>

Will expose the global variable to window.Artplayer.

Usage

<div class="artplayer-app"></div>
var art = new Artplayer({
    container: '.artplayer-app',
    url: 'path/to/video.mp4',
});

Donations

We accept donations through these channels:

pay

QQ Group

QQ Group

License

MIT © Harvey Zack