DPlayer/docs

DPlayer

Wow, such a lovely HTML5 danmaku video player

Introduction

Demo

Docs

Using DPlayer on your project? Let me know!

Screenshot

Install

$ npm install dplayer --save

CDN

cdnjs

BootCDN

Usage

HTML structure

<div id="player1" class="dplayer"></div>
<!-- ... -->
<script src="dist/DPlayer.min.js"></script>

Options

var dp = new DPlayer({
    element: document.getElementById('player1'),                       // Optional, player element
    autoplay: false,                                                   // Optional, autoplay video, not supported by mobile browsers
    theme: '#FADFA3',                                                  // Optional, theme color, default: #b7daff
    loop: true,                                                        // Optional, loop play music, default: true
    lang: 'zh',                                                        // Optional, language, `zh` for Chinese, `en` for English, default: Navigator language
    screenshot: true,                                                  // Optional, enable screenshot function, default: false, NOTICE: if set it to true, video and video poster must enable Cross-Origin
    hotkey: true,                                                      // Optional, binding hot key, including left right and Space, default: true
    preload: 'auto',                                                   // Optional, the way to load music, can be 'none' 'metadata' 'auto', default: 'auto'
    video: {                                                           // Required, video info
        url: '若能绽放光芒.mp4',                                         // Required, video link
        pic: '若能绽放光芒.png',                                         // Optional, video poster
        type: 'auto'                                                   // Optional, video type, `flv` for flv format, `hls` for m3u8 format, `normal` for mp4 ogg and webm format, `auto` for automatic detection, default: `auto`
    },
    danmaku: {                                                         // Optional, showing danmaku, ignore this option to hide danmaku
        id: '9E2E3368B56CDBB4',                                        // Required, danmaku id, NOTICE: it must be unique, can not use these in your new player: `https://api.prprpr.me/dplayer/list`
        api: 'https://api.prprpr.me/dplayer/',                             // Required, danmaku api
        token: 'tokendemo',                                            // Optional, danmaku token for api
        maximum: 1000,                                                 // Optional, maximum quantity of danmaku
        addition: ['https://api.prprpr.me/dplayer/bilibili?aid=4157142']   // Optional, additional danmaku, see: `Bilibili 弹幕支持`
    }
});

API

• dp.play() // Resume play
• dp.play(time) // Set currentTime
• dp.pause() // Pause
• dp.toggle() // Toggle between play and pause
• dp.on(event, handler) // Event binding
• dp.switchVideo(video, danmaku) // Switch to a new video, the format of video and danmaku is the same as option
• dp.dan // Return danmaku info
• dp.danIndex // Return danmaku index
• dp.video // Return native video, most native api are supported
  • dp.video.currentTime // Returns the current playback position
  • dp.video.loop // Returns whether the video should start over again when finished
  • dp.vidio.paused // Returns whether the video paused
  • Most native api

Event binding

dp.on(event, handler)

event:

• play: Triggered when DPlayer start play
• pause: Triggered when DPlayer paused
• canplay: Triggered when enough data is available that DPlayer can be played
• playing: Triggered periodically when DPlayer is playing
• ended: Triggered when DPlayer ended
• error: Triggered when an error occurs

HLS support (Live Video, M3U8 format)

It requires the library hls.js and it should be loaded before DPlayer.min.js.

Live danamku is not supported yet.

<div id="player1" class="dplayer"></div>
<!-- ... -->
<script src="plugin/hls.min.js"></script>
<script src="dist/DPlayer.min.js"></script>

<script>
var dp = new DPlayer({
    // ...
    video: {
        url: 'xxx.m3u8',
        type: 'hls'
        // ...
    }
});
</script>

FLV support

It requires the library flv.js and it should be loaded before DPlayer.min.js.

<div id="player1" class="dplayer"></div>
<!-- ... -->
<script src="plugin/flv.min.js"></script>
<script src="dist/DPlayer.min.js"></script>

<script>
var dp = new DPlayer({
    // ...
    video: {
        url: 'xxx.flv',
        type: 'flv'
        // ...
    }
});
</script>

Work with module bundler

var DPlayer = require('DPlayer');
var dp = new DPlayer(option);

Danmaku back-end

Ready-made API:

https://api.prprpr.me/dplayer/

Build yourself:

Required environment

• Node.js
• Mongodb
• Redis

Bilibili danmaku and video link

Danmaku

API:

https://api.prprpr.me/dplayer/bilibili?aid=【bilibili视频AV号】

or https://api.prprpr.me/dplayer/bilibili?cid=【bilibili视频cid】

var option = {
    danmaku: {
        // ...
        addition: ['https://api.prprpr.me/dplayer/bilibili?aid=【bilibili视频AV号】']
    }
}

Video link

https://api.prprpr.me/dplayer/video/bilibili?aid=【bilibili视频AV号】

or https://api.prprpr.me/dplayer/video/bilibili?cid=【bilibili视频cid】

Run in development

$ npm install
$ npm run dev

Make a release

$ npm install
$ npm run build

Related Projects

• DPlayer-for-typecho

• Hexo-tag-dplayer

• DPlayer_for_Z-BlogPHP

• 纸飞机视频区插件(DPlayer for Discuz!)

• dplayer_py_backend

• dplayer_lua_backend

• DPlayer for WordPress

LICENSE

The Star And Thank Author License (SATA)