这是一个基于Alipayer 开发并封装于vue的播放器

由于项目需要接入rtmp协议的直播流,用于实时监控,看了网上的几个开源播放器,最后选择了阿里云的开源播放器,Alipayer,但是Alipayer是cdn加载的,且没得一个正式的vue版本,最后还是选择了自己手写吧.废话不多说,直接上代码,如下:

项目地址: https://github.com/langyuxiansheng/vue-aliplayer-v2

本项目在线演示

阿里云播放器在线演示

假如此轮子对你有帮助,请顺手star一下吧.o( ̄︶ ̄)o

1.安装使用! 下载安装npm包

npm i vue-aliplayer-v2 --save
or
yarn add vue-aliplayer-v2 
//全局注册 main.js
import VueAliplayerV2 from 'vue-aliplayer-v2';

Vue.use(VueAliplayerV2);

2.组件中使用

组件模板使用,但需要注意的是,假如你的页面中有多个播放器,那么这个id需要唯一!!,ID必传,只有一个的时候,可以忽略,命名只能是有效字符开头. 下面的视频连接是无效的,需要自己去替换成有效的.

<template>
    <div id="app">
        <vue-aliplayer-v2 
            @ready="handleReady" 
            ref="VueAliplayerV2" 
            id="player-1194076936807171180" 
            :options="options" />
        <button @click="play()">播放</button>
        <button @click="pause()">暂停</button>
        <button @click="replay()">重播</button>
        <button @click="getCurrentTime()">播放时刻</button>
    </div>
</template>
<script>
export default {
    data(){
        return {
            options: {  //配置项  
                source:'rtmp://182.112.15.258:1688/hls/1194076936807171180'
            }
        }
    },
    methods:{

        /**
         * 在这里需要注意的是  this.$refs 可能会返回是数组,或者对象,这个在用的时候需要注意一下.且因为是异步渲染dom,所以最好是在 this.$nextTick(()=>{ //todo }); 里面调用     
         * 事件可以参考文档 https://help.aliyun.com/document_detail/125572.html?spm=a2c4g.11186623.6.1085.36fc6fc57WKZ5P#h2-u64ADu653Eu5668u4E8Bu4EF63
         */
        play(){
            this.$refs.VueAliplayerV2.play()
        },

        pause(){
            this.$refs.VueAliplayerV2.pause();
        },

        replay(){
            this.$refs.VueAliplayerV2.replay();
        },

        getCurrentTime(){
            this.$refs.VueAliplayerV2.getCurrentTime();
        },
        
        /**
         * 播放器事件回调 
         */
        handleReady(e){
            console.log(`ready`,e);
        }
    }
}
</script>
<style lang="less" scoped>
* {
    margin: 0;
    padding: 0;
}
.player-btns{
    width: 800px;
    margin: 0 auto;
    display: flex;
    justify-content: space-between;
    span {
        margin: 0 auto;
        display: inline-block;
        padding: 5px 10px;
        width: 150px;
        height: 40px;
        line-height: 40px;
        border: 1px solid #eee;
        background: #e1e1e1;
        border-radius: 10px;
        text-align: center;
        margin: 20px auto;
        cursor: pointer;
    }
}
</style>

3.功能与配置

props:{
     options: {  //配置项 
        required: false,
        type: [Object],
        default: () => null
    },
    id:{  //播放器的ID 唯一标识符 不传就是默认的 但是有多个的时候不一定是唯一的
        required: false,
        type: [String],
        default: `player-${Date.parse(new Date())}`
    }
}

3.1 配置项 options 属性

可以参考 属性和接口说明

名称类型说明
sourceString视频播放地址url:单独url。默认状态,表示使用vid+playauth。source播放方式优先级最高。source支持多清晰度设置:source:’{“HD”:”address1”,”SD”:”address2”’,详情参见多清晰度播放。
vidString媒体转码服务的媒体Id。
playauthString播放权证,如何得到参见获取playauth。
heightString播放器高度,可形如‘100%’或者‘100px’,chrome浏览器下flash播放器分别不能小于397x297。
widthString播放器宽度,可形如‘100%’或者‘100px’,chrome浏览器下flash播放器分别不能小于397x297。
videoWidthString视频宽度,仅h5支持。详情参见旋转和镜像。
videoHeightString视频高度,仅h5支持。详情参见旋转和镜像。
preloadBoolean播放器自动加载,目前仅h5可用。
coverString播放器默认封面图片,请填写正确的图片url地址。需要autoplay为’false’时,才生效。Flash播放器封面也需要开启允许跨域访问。
isLiveBoolean播放内容是否为直播,直播时会禁止用户拖动进度条。
autoplayBoolean播放器是否自动播放,在移动端autoplay属性会失效。Safari11不会自动开启自动播放如何开启。
rePlayBoolean播放器自动循环播放。
useH5PrismBoolean指定使用H5播放器。
useFlashPrismBoolean指定使用Flash播放器。
playsinlineBooleanH5是否内置播放,有的Android浏览器不起作用。
showBufferBoolean显示播放时缓冲图标,默认true。
skinResUrl说明:皮肤图片,不建议随意修改该字段,如要修改,请参照皮肤定制。
skinLayoutArray Boolean说明:功能组件布局配置,不传该字段使用默认布局。传false隐藏所有功能组件,请参照皮肤定制。
controlBarVisibilityString控制面板的实现,默认为‘hover’。可选的值为:‘click’、‘hover’、‘always’。
showBarTimeString控制栏自动隐藏时间(ms)。
extraInfoString说明:JSON串用于定制性接口参数。
>>1.“fullTitle”:“测试页面”全屏时显示视频标题(仅flash支持)。
>>2. “m3u8BufferLength”:“30”播放m3u8时加载缓存ts文件长度单位(秒)(仅flash支持)。
>>3. “liveStartTime”:“2016/08/17 12:00:00”,直播开始时间,用于提示直播未开始(仅flash支持)。
>>4. “liveOverTime”:“2016/08/17 14:00:00”,直播结束时间,用于提示直播结束(仅flash支持)。
enableSystemMenuBoolean是否允许系统右键菜单显示,默认为false。
formatString指定播放地址格式,只有使用vid的播放方式时支持,可选值为’mp4’、’m3u8’、’flv’、’mp3’,默认为空,仅H5支持。
mediaTypeString指定返回音频还是视频,只有使用vid的播放方式时支持。可选值为’video’和’audio’,默认为’video’,‘audio’主要是针对只包含音频的视频格式,比如音频的mp4,仅H5支持。
qualitySortString指定排序方式,只有使用vid + plauth播放方式时支持。‘desc’表示按倒序排序(即:从大到小排序),‘asc’表示按正序排序(即:从小到大排序),默认值:‘asc’,仅H5支持。
definitionString显示视频清晰度,多个用逗号分隔,比如:’FD,LD’,此值是vid对应流清晰度的一个子集,取值范围:FD(流畅)LD(标清)SD(高清)HD(超清)OD(原画)2K(2K)4K(4K),仅H5支持。
defaultDefinitionString默认视频清晰度,此值是vid对应流的一个清晰度,取值范围:FD(流畅)LD(标清)SD(高清)HD(超清)OD(原画)2K(2K)4K(4K),仅H5支持。
x5_typeString声明启用同层H5播放器,启用时设置的值为‘h5’,详情参见同层播放。
x5_fullscreenBoolean声明视频播放时是否进入到TBS的全屏模式,默认为false。当需要把视频做为背景时,设置为true,详情参见同层播放。
x5_video_positionString声明视频播在界面上的位置,默认为“center”。可选值为:“top”,“center”,详情参见同层播放。
x5_orientationString声明TBS播放器支持的方向,可选值:landscape:横屏,portraint:竖屏,详情参见同层播放。
x5LandscapeAsFullScreenString声明TBS全屏播放是否横屏,默认值为true。
autoPlayDelayNumber延迟播放时间,单位为秒。详情参见延迟播放
autoPlayDelayDisplayTextString延迟播放提示文本,详情参见延迟播放。
languageString国际化,默认为‘zh-cn’。如果未设置,则采用浏览器语言。可选值为‘zh-cn’、‘en-us’或其它值。
languageTextsJSON自定义国际化文本json结构,key的值需要和language属性值对应起来。例子:{jp:{Play:”Play”}},自定义值参见Json结构。
snapshotBooleanflash启用截图功能。
snapshotWatermarkObjectH5设置截图水印。
useHlsPluginForSafariBooleanSafari浏览器可以启用Hls插件播放,Safari 11除外。
enableStashBufferForFlvBooleanH5播放flv时,设置是否启用播放缓存,只在直播下起作用。
stashInitialSizeForFlvNumberH5播放flv时,初始缓存大小,只在直播下起作用。
loadDataTimeoutNumber缓冲多长时间后,提示用户切换低清晰度,默认:20秒。
waitingTimeoutNumber最大缓冲超时时间,超过这个时间会有错误提示,默认:60秒。
liveStartTimeString直播开始时间,直播时移功能使用,格式为:“2018/01/04 12:00:00”。
liveOverTimeString直播结束时间,直播时移功能使用,格式为:“2018/01/04 12:00:00”。
liveTimeShiftUrlString直播可用时移查询地址,详情参见直播时移。
liveShiftSourceStringflv直播地址播放时,hls的流地址,详情参见直播时移。
recreatePlayerFunctionflv直播和hls时移切换是,重新创建播放器方法,详情参见直播时移。
diagnosisButtonVisibleBoolean是否显示检测按钮,默认为true。
disableSeekBoolean禁用进度条的Seek,默认为false,仅Flash支持。
encryptTypeint加密类型,播放点播私有加密视频时,设置值为1,默认值为0。
progressMarkersArray进度条打点内容数组,详情参见进度条打点。
vodRetryint点播失败重试次数,默认3次
liveRetryint直播播放失败重试次数,默认5次

3.2 播放器方法

// 暂停播放
this.$refs.VueAliplayerV2.pause();

可以参考 播放器接口方法

名称参数说明
play-播放视频。
pause-暂停视频。
replay-重播视频。
seektime跳转到某个时刻进行播放,time的单位为秒。
getCurrentTime-获取当前的播放时刻,返回的单位为秒。
getDuration-获取视频总时长,返回的单位为秒,这个需要在视频加载完成以后才可以获取到,可以在play事件后获取。
getVolume-获取当前的音量,返回值为0-1的实数。ios和部分android会失效。
setVolume-设置音量,vol为0-1的实数,ios和部分android会失效。
loadByUrlurl,time直接播放视频url,time为可选值(单位秒)。目前只支持同种格式(mp4/flv/m3u8)之间切换。暂不支持直播rtmp流切换。
replayByVidAndPlayAuthvid:视频id,playauth:播放凭证目前只支持H5播放器。暂不支持不同格式视频间的之间切换。暂不支持直播rtmp流切换。
replayByVidAndAuthInfo仅MPS用户时使用,参数顺序为:vid、accId、accSecret、stsToken、authInfo、domainRegion目前只支持H5播放器。暂不支持不同格式视频间的之间切换。暂不支持直播rtmp流切换。
setPlayerSizew,h设置播放器大小w,h可分别为400px像素或60%百分比。chrome浏览器下flash播放器分别不能小于397x297。
setSpeedspeed手动设置播放的倍速,倍速播放仅H5支持。移动端可能会失效,比如android微信。倍速播放UI默认是开启的。如果自定义过skinLaout属性,需要添加speedButton项到数组里:
>>{name:“speedButton”,align:“tr”,x:10,y:23}
setSanpshotPropertieswidth:宽度,height:高度,rate:截图质量设置截图参数。
requestFullScreen-播放器全屏,仅H5支持。
cancelFullScreen-播放器退出全屏,iOS调用无效,仅H5支持。
getIsFullScreen-获取播放器全屏状态,仅H5支持。
getStatus-获取播放器状态,包含的值:‘init’,‘ready’,‘loading’,‘play’,‘pause’,‘playing’,‘waiting’,‘error’,‘ended’
setLiveTimeRange开始时间,结束时间设置直播的开始结束时间,开启直播时移功能时使用。例子:player.liveShiftSerivce.setLiveTimeRange(“”,‘2018/01/04 20:00:00’)
setRotaterotate 旋转角度参数为旋转角度, 正数为正时针旋转, 负数为逆时针旋转。例如: setRotate(90)。详情参见旋转和镜像。
getRotate-获取旋转角度。详情参见旋转和镜像。
setImageimage:镜像类型,可选值为:horizon,vertical设置镜像,例如: setImage(‘horizon’)。详情参见旋转和镜像。
dispose-播放器销毁
setCovercover封面地址设置封面
setProgressMarkersmarkers打点数据集合设置打点数据
setPreviewTimetime试看时间设置试看时间,单位为秒,详情参见试看
getPreviewTime-获取试看时间
isPreview-是否试看
offev:事件名[String],handle,事件回调方法[Function]通过播放器实例的off方法取消绑定的方法

4.播放器事件

<template>
    <vue-aliplayer-v2  @ready="handleReady" />
</template>
<script>
export default {
    methods:{
        /**
         * 播放器事件回调 
         */
        handleReady(e){
            console.log(`ready`,e);
        }
    }
}
</script>

可以参考 播放器事件

名称说明
ready播放器视频初始化按钮渲染完毕。播放器UI初始设置需要此事件后触发,避免UI被初始化所覆盖。播放器提供的方法需要在此事件发生后才可以调用。
play视频由暂停恢复为播放时触发。
pause视频暂停时触发。
canplay能够开始播放音频/视频时发生,会多次触发,仅H5播放器。
playing播放中,会触发多次。
ended当前视频播放完毕时触发。
liveStreamStop直播流中断时触发。m3u8/flv/rtmp在重试5次未成功后触发。提示上层流中断或需要重新加载视频。PS:m3u8一直自动重试,不需要上层添加重试。
onM3u8Retrym3u8直播流中断后重试事件,每次断流只触发一次。
hideBar控制栏自动隐藏事件。
showBar控制栏自动显示事件。
waiting数据缓冲事件。
timeupdate播放位置发生改变时触发,仅H5播放器。可通过getCurrentTime方法,得到当前播放时间。
snapshoted截图完成事件。
requestFullScreen全屏事件,仅H5支持。
cancelFullScreen取消全屏事件,iOS下不会触发,仅H5支持。
error错误事件。
startSeek开始拖拽,参数返回拖拽点的时间。
completeSeek完成拖拽,参数返回拖拽点的时间。

5. 图片展示

6.二次开发 下载项目

git clone https://github.com/langyuxiansheng/vue-aliplayer-v2.git

Project setup

cd vue-aliplayer-v2

npm install

Compiles and hot-reloads for development

npm run dev

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

7.缺陷 & 后期计划

您有功能建议,或者bug反馈请留言.

8.感谢


Customize configuration

See Configuration Reference.

9.项目案例展示

9.1 web PC端互联网监管,视频监控直播流

9.2微信公众号 H5效果展示
 

Logo

前往低代码交流专区

更多推荐