Giter Club home page Giter Club logo

larkplayer's Introduction

简介

larkplayer 是一款移动端的播放器,基于 html5 video 标签构建。保留 vieo 标签 所有原生的属性、方法和事件,同时也增加了一些自定义方法和事件

larkplayer 有如下特性

  • 事件机制,可通过 on off one trigger 处理事件
  • 插件机制,可开发自定义插件附加到播放器上
  • 自定义样式

如需更加详细的文档,请参见GitBook

快速上手

下载

npm install larkplayer

使用

通过模块化引用
const larkplayer = require('larkplayer');
// 传入的 my-html5-video 应当是已存在的 video 标签的 id
larkplayer('my-html5-video', {
    // 支持所有的 html5 标准属性
    width: 100,
    height: 100,
    src: 'https://xxx/xxx.mp4',
    // 支持自定义的 source 方法,用于处理 video 中的 source 标签
    source: [{
        src: 'https://xxx/a.m3u8',
        // type 属性可选
        type: 'application/x-mpegURL'
    }, {
        src: 'https://xxx/b.mp4',
        type: 'video/mp4'
    }]
});
// 支持所有的 html5 标准事件
larkplayer.on('player', event => {
    console.log('play')
});
larkplayer.on('pause', event => {
    console.log('pause');
});
// 支持自定义 firstplay 事件,每个视频时播放只触发一次
larkplayer.on('firstplay', event => {
    console.log('Firstplay triggered only once when video played');
});
以 script 的方式使用

dist 目录下有对应的打包好的 js 和 css 文件, 要以 script 标签的形式插入到 html 中,直接引用即可。

<!DOCTYPE html>
<html>
<head>
    <title>test larkplayer</title>
    <link rel="stylesheet" type="text/css" href="./node_modules/larkplayer/dist/larkplayer.min.css">
</head>
<body>
    <video id="my-video" src="https://baikebcs.bdimg.com/baike-other/cool.mp4" width="400" height="300" controls></video>
    <script type="text/javascript" src="./node_modules/larkplayer/dist/larkplayer.min.js"></script>
    <script type="text/javascript">
        // js 文件以 umd 的形式包装,以 script 的形式引用时,larkplayer 会直接挂载在 window 上
        var player = larkplayer('my-video');
        player.on('play', function () {
            console.log('play');
        });
        player.on('firstplay', function () {
            console.log('firstplay');
        });
        player.on('ended', function () {
            console.log('ended');
            player.src('http://www.w3school.com.cn/i/movie.ogg');
        });
    </script>
</body>
</html>

larkplayer's People

Contributors

dblate avatar

Watchers

Bluespy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.