@neosjs/videojs-player
Video.js 的 Vue 3 封装组件。以 props 形式透出 Video.js 的全部配置,内置中文语言、常用快捷键、标题栏、品牌 Logo、多线路切换等扩展,并支持响应式 v-model 与作用域插槽,内置 DevTools 打开检测以保护视频内容不被调试抓取。
TIP
组件依赖 video.js(peer dependency),请一并安装。
安装
sh
pnpm add @neosjs/videojs-player video.jssh
npm i @neosjs/videojs-player video.jssh
yarn add @neosjs/videojs-player video.js快速上手
局部引入组件与样式即可使用(组件名 NeosPlayer、NeosVideoPlayer 均可):
vue
<script setup lang="ts">
import { NeosPlayer } from '@neosjs/videojs-player'
import { ref } from 'vue'
import '@neosjs/videojs-player/dist/neos-player.css'
const muted = ref(false)
const volume = ref(0.1)
const playbackRate = ref(1)
const sources = [
{
src: 'https://example.com/video/index.m3u8',
type: 'application/x-mpegURL',
label: '线路一'
},
{
src: 'https://example.com/video/trailer.mp4',
type: 'video/mp4',
label: '线路二'
}
]
function onMountedPlayer(payload: any) {
// payload: { video, player, state }
console.log('播放器挂载完成', payload.player)
}
</script>
<template>
<NeosPlayer
v-model:muted="muted"
v-model:volume="volume"
v-model:playback-rate="playbackRate"
class="vjs-big-play-centered"
:sources="sources"
poster="https://example.com/poster.jpg"
:controls="true"
:autoplay="false"
:loop="false"
language="zh"
:playback-rates="[0.5, 1, 1.5, 2]"
:fluid="false"
:width="700"
:height="395"
@mounted="onMountedPlayer"
/>
</template>全局注册:
ts
import NeosVideoPlayer from '@neosjs/videojs-player'
import { createApp } from 'vue'
import '@neosjs/videojs-player/dist/neos-player.css'
const app = createApp(App)
app.use(NeosVideoPlayer) // 注册全局组件 NeosPlayer / NeosVideoPlayer使用扩展能力(标题栏、品牌 Logo、自定义右键菜单等):
vue
<NeosPlayer
:sources="sources"
:title-bar="{ title: '视频标题', description: '视频描述' }"
:brand-logo="{
image: 'https://example.com/logo.svg',
title: '品牌名',
width: 98,
height: 22
}"
:context-menu="[
{ name: 'CopyVideoURL', label: '复制链接', event: () => {} },
{ name: 'About', label: '关于', event: () => {} }
]"
:plugins="{ sourcesSwitcher: {} }"
/>API
Props
组件以 props 形式支持 Video.js 的常用配置(未列出的配置可通过 options 传入完整的 VideoJsPlayerOptions):
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
src | string | - | 视频地址 |
sources | Array | - | 多线路视频源列表,元素支持 src、type、label(线路名)等字段 |
poster | string | - | 封面图地址 |
controls | boolean | - | 是否显示控制栏 |
autoplay | boolean | 'muted' | 'play' | 'any' | - | 自动播放策略 |
loop | boolean | - | 是否循环播放 |
muted | boolean | - | 是否静音(支持 v-model:muted) |
preload | 'auto' | 'metadata' | 'none' | - | 预加载策略 |
width / height | number | - | 播放器宽高(支持 v-model:width / v-model:height) |
volume | number | - | 音量 0 ~ 1(支持 v-model:volume) |
playbackRate | number | - | 播放倍速(支持 v-model:playbackRate) |
playbackRates | number[] | - | 可选倍速列表 |
language | string | 'zh' | 语言 |
fluid | boolean | - | 流式布局(随容器宽度自适应) |
fill | boolean | - | 填满容器 |
aspectRatio | string | - | 宽高比,如 '16:9' |
responsive | boolean | - | 是否响应式(配合 breakpoints) |
tracks | Array | - | 字幕等文本轨道 |
playsinline | boolean | true | 移动端内联播放 |
crossorigin | string | 'anonymous' | 跨域属性 |
children | Array | 内置组件列表 | 播放器子组件列表(加载器、封面、标题栏、品牌 Logo、控制栏等) |
controlBar | object | 内置布局 | 控制栏配置(进度条、播放按钮、倍速、音量、全屏等) |
plugins | object | - | 插件配置(如 sourcesSwitcher 多线路切换) |
titleBar | object | - | 标题栏配置:{ title, description } |
brandLogo | object | - | 品牌 Logo 配置:{ image, title, width, height } 等 |
contextMenu | Array | - | 自定义右键菜单:{ name, label, icon, event } |
userActions | object | 内置快捷键 | 快捷键配置,默认:空格播放/暂停、M 静音、F 全屏 |
options | object | - | 完整的 Video.js 初始化选项 |
debug | boolean | - | 是否开启 debug 模式 |
事件
组件支持 Video.js 全部事件(以驼峰形式透出),常用的有:
| 事件 | 说明 |
|---|---|
mounted | 播放器挂载完成,回调参数为 { video, player, state } |
unmounted | 播放器卸载完成 |
ready | 播放器准备完成 |
play / pause / ended | 播放 / 暂停 / 结束 |
timeupdate | 播放进度更新 |
durationchange | 时长变化 |
volumechange | 音量变化 |
ratechange | 倍速变化 |
fullscreenchange | 全屏状态变化 |
error | 播放错误 |
loadedmetadata | 元数据加载完成 |
canplay | 可以播放 |
devtoolsOpened | 检测到浏览器 DevTools 打开,回调参数为 { isOpen } |
其余事件如 onPlay、onSeeked、onEnterPictureInPicture 等命名方式与 Video.js 事件一一对应。
插槽
| 插槽 | 作用域参数 | 说明 |
|---|---|---|
| default | { video, player, state } | 播放器挂载后渲染的自定义内容,可拿到 video 元素、player 实例与只读 state |
WARNING
组件内置 DevTools 检测:当浏览器开发者工具打开时,播放器会暂停并弹出错误提示,关闭后自动恢复。如需调试播放器,可设置 debug 属性。