Vue3视频播放(Video)

简介: 这篇文章介绍了如何在Vue 3框架中创建一个视频播放组件(Video),支持自定义视频源、封面、自动播放等多种播放选项和样式设置。

可自定义设置以下属性:

  • 视频文件地址(src),类型:string,默认 undefined,支持网络地址 https 和相对地址

  • 视频封面地址(poster),类型:string,默认 undefined,支持网络地址 https 和相对地址

  • 在未设置封面时,自动获取视频第 second 秒指定帧作为封面图(second),类型:number,单位 s,默认 0.5s,由于不少视频第一帧为黑屏,故设置视频开始播放时间为0.5s,即取该时刻帧作为封面图

  • 视频播放器宽度(width),类型:number,单位 px,默认 800

  • 视频播放器高度(height),类型:number,单位 px,默认 450

  • 视频就绪后是否马上播放(autoplay),优先级高于preload,类型:boolean,默认 false

  • 是否向用户显示控件,比如是否向用户显示控件,比如进度条,全屏等(controls),类型:boolean,默认 true

  • 视频播放完成后,是否循环播放(loop),类型:boolean,默认 false

  • 是否静音(muted),类型:boolean,默认 false

  • 是否在页面加载后载入视频(preload)如果设置了autoplay属性,则preload将被忽略,类型:'auto' | 'metadata' | 'none',默认'metadata' // auto:一旦页面加载,则开始加载视频; metadata:当页面加载后仅加载视频的元数据 none:页面加载后不应加载视频

  • 播放暂停时是否显示播放器中间的暂停图标(showPlay),类型:boolean,默认 true

  • video的poster默认图片和视频内容的缩放规则(fit),类型:'none' | 'fill' | 'contain' | 'cover',默认 'contain' // none:(默认)保存原有内容,不进行缩放; fill:不保持原有比例,内容拉伸填充整个内容容器; contain:保存原有比例,内容以包含方式缩放; cover:保存原有比例,内容以覆盖方式缩放

注:为避免与 HTML5 原生标签 冲突,使用组件时必须使用大写组件名:

效果如下图:在线预览

①创建视频播放组件Video.vue:

<script setup lang="ts">
import { ref, computed, onMounted } from 'vue'
interface Props {
  src?: string // 视频文件地址,支持网络地址 https 和相对地址
  poster?: string // 视频封面地址,支持网络地址 https 和相对地址
  second?: number // 在未设置封面时,自动截取视频第 second 秒对应帧作为视频封面
  width?: string | number // 视频播放器宽度,单位 px
  height?: string | number // 视频播放器高度,单位 px
  autoplay?: boolean // 视频就绪后是否马上播放,优先级高于 preload
  controls?: boolean // 是否向用户显示控件,比如进度条,全屏等
  loop?: boolean // 视频播放完成后,是否循环播放
  muted?: boolean // 是否静音
  preload?: 'auto' | 'metadata' | 'none' // 是否在页面加载后载入视频,如果设置了 autoplay 属性,则 preload 将被忽略
  showPlay?: boolean // 播放暂停时是否显示播放器中间的暂停图标
  fit?: 'none' | 'fill' | 'contain' | 'cover' // video 的 poster 默认图片和视频内容缩放规则
}
const props = withDefaults(defineProps<Props>(), {
  src: undefined,
  poster: undefined,
  second: 0.5,
  width: 800,
  height: 450,
  /*
    参考 MDN 自动播放指南:https://developer.mozilla.org/zh-CN/docs/Web/Media/Autoplay_guide
    Autoplay 功能
    据新政策,媒体内容将在满足以下至少一个的条件下自动播放:
    1.音频被静音或其音量设置为 0
    2.用户和网页已有交互行为(包括点击、触摸、按下某个键等等)
    3.网站已被列入白名单;如果浏览器确定用户经常与媒体互动,这可能会自动发生,也可能通过首选项或其他用户界面功能手动发生
    4.自动播放策略应用到<iframe>或者其文档上
    autoplay:由于目前在最新版的Chrome浏览器(以及所有以Chromium为内核的浏览器)中,
    已不再允许自动播放音频和视频。就算你为video或audio标签设置了autoplay属性也一样不能自动播放!
    解决方法:设置视频 autoplay 时,视频必须设置为静音 muted: true 即可实现自动播放,
    然后用户可以使用控制栏开启声音,类似某宝商品自动播放的宣传视频逻辑
  */
  autoplay: false,
  controls: true,
  loop: false,
  muted: false,
  /*
    preload可选属性:
    auto: 一旦页面加载,则开始加载视频;
    metadata: 当页面加载后仅加载视频的元数据(例如长度),建议使用 metadata,以便视频自动获取第一帧作为封面 poster
    none: 页面加载后不应加载视频
  */
  preload: 'metadata',
  showPlay: true,
  /*
    fit可选属性:
    none: 保存原有内容,不进行缩放;
    fill: 不保持原有比例,内容拉伸填充整个内容容器;
    contain: 保存原有比例,内容以包含方式缩放;
    cover: 保存原有比例,内容以覆盖方式缩放
  */
  fit: 'contain'
})
const veoWidth = computed(() => {
  if (typeof props.width === 'number') {
    return props.width + 'px'
  }
  return props.width
})
const veoHeight = computed(() => {
  if (typeof props.height === 'number') {
    return props.height + 'px'
  }
  return props.height
})
const veoRef = ref()
// 参考文档:https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/video
const veoPoster = ref()
const originPlay = ref(true)
const hidden = ref(false) // 是否隐藏播放器中间的播放按钮
onMounted(() => {
  if (props.autoplay) {
    hidden.value = true
    originPlay.value = false
  }
  /*
    自定义设置播放速度,经测试:
    在vue2中需设置:this.$refs.veoRef.playbackRate = 2
    在vue3中需设置:veoRef.value.defaultPlaybackRate = 2
  */
  // veoRef.value.defaultPlaybackRate = 2
})
/*
  loadedmetadata 事件在元数据(metadata)被加载完成后触发
  loadeddata 事件在媒体当前播放位置的视频帧(通常是第一帧)加载完成后触发
    若在移动/平板设备的浏览器设置中开启了流量节省(data-saver)模式,该事件则不会被触发。
  preload 为 none 时不会触发
*/
function getPoster() {
  // 在未设置封面时,自动截取视频0.5s对应帧作为视频封面
  // 由于不少视频第一帧为黑屏,故设置视频开始播放时间为0.5s,即取该时刻帧作为封面图
  veoRef.value.currentTime = props.second
  // 创建canvas元素
  const canvas = document.createElement('canvas')
  const ctx = canvas.getContext('2d')
  // canvas画图
  canvas.width = veoRef.value.videoWidth
  canvas.height = veoRef.value.videoHeight
  ctx?.drawImage(veoRef.value, 0, 0, canvas.width, canvas.height)
  // 把canvas转成base64编码格式
  veoPoster.value = canvas.toDataURL('image/png')
}
function onPlay() {
  if (originPlay.value) {
    veoRef.value.currentTime = 0
    originPlay.value = false
  }
  if (props.autoplay) {
    veoRef.value?.pause()
  } else {
    hidden.value = true
    veoRef.value?.play()
  }
}
function onPause() {
  hidden.value = false
}
function onPlaying() {
  hidden.value = true
}
</script>
<template>
  <div class="m-video" :class="{ 'video-hover': !hidden }" :style="`width: ${veoWidth}; height: ${veoHeight};`">
    <video
      ref="veoRef"
      class="u-video"
      :style="`object-fit: ${fit};`"
      :src="src"
      :poster="poster ? poster : veoPoster"
      :autoplay="autoplay"
      :controls="!originPlay && controls"
      :loop="loop"
      :muted="autoplay || muted"
      :preload="preload"
      crossorigin="anonymous"
      @loadedmetadata="poster ? () => false : getPoster()"
      @pause="showPlay ? onPause() : () => false"
      @playing="showPlay ? onPlaying() : () => false"
      @click.prevent.once="onPlay"
      v-bind="$attrs"
    >
      您的浏览器不支持video标签。
    </video>
    <span v-show="originPlay || showPlay" class="icon-play" :class="{ 'icon-hidden': hidden }">
      <svg class="play-svg" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 34 34">
        <path
          d="M28.26,11.961L11.035,0.813C7.464-1.498,3,1.391,3,6.013v21.974c0,4.622,4.464,7.511,8.035,5.2L28.26,22.039
          C31.913,19.675,31.913,14.325,28.26,11.961z"
        ></path>
      </svg>
    </span>
  </div>
</template>
<style lang="less" scoped>
.m-video {
  position: relative;
  background: #000;
  cursor: pointer;
  .u-video {
    display: inline-block;
    width: 100%;
    height: 100%;
    vertical-align: bottom;
  }
  .icon-play {
    display: inline-block;
    position: absolute;
    top: 0;
    right: 0;
    bottom: 0;
    left: 0;
    margin: auto;
    width: 80px;
    height: 80px;
    border-radius: 50%;
    background-color: rgba(0, 0, 0, 0.6);
    pointer-events: none;
    transition: background-color 0.3s;
    .play-svg {
      display: inline-block;
      fill: #fff;
      width: 29px;
      height: 34px;
      margin-top: 23px;
      margin-left: 27px;
    }
  }
  .icon-hidden {
    opacity: 0;
  }
}
.video-hover {
  &:hover {
    .icon-play {
      background-color: rgba(0, 0, 0, 0.7);
    }
  }
}
</style>

②在要使用的页面引入:

<script setup lang="ts">
import Video from './Video.vue'
import { ref } from 'vue'

const src = ref('https://cdn.jsdelivr.net/gh/themusecatcher/resources@0.0.3/Bao.mp4')
const poster = ref('https://cdn.jsdelivr.net/gh/themusecatcher/resources@0.0.3/bao.jpg')
</script>

<template>
  <div>
    <h2 class="mb10">Video 播放器基本使用</h2>
    <Video :src="src" :poster="poster" />
    <h2 class="mt30 mb10">自动播放</h2>
    <Video autoplay :src="src" :poster="poster" />
    <h2 class="mt30 mb10">自动截取视频指定帧作为视频封面</h2>
    <Video :src="src" :second="3" />
  </div>
</template>
相关文章
|
17天前
vue3学习(3)
vue3学习(3)
|
14天前
|
JavaScript API
Vue3中的计算属性能否动态修改
【9月更文挑战第5天】Vue3中的计算属性能否动态修改
49 10
|
7天前
|
JavaScript
Vue3中路由跳转的语法
Vue3中路由跳转的语法
111 58
|
9天前
|
前端开发
vue3+ts项目中使用mockjs
vue3+ts项目中使用mockjs
209 58
|
5天前
|
JavaScript 索引
Vue 2和Vue 3的区别以及实现原理
Vue 2 的响应式系统通过Object.defineProperty来实现,它为对象的每个属性添加 getter 和 setter,以便追踪依赖并响应数据变化。
20 9
|
7天前
|
JavaScript 开发工具
vite如何打包vue3插件为JSSDK
【9月更文挑战第10天】以下是使用 Vite 打包 Vue 3 插件为 JS SDK 的步骤:首先通过 `npm init vite-plugin-sdk --template vue` 创建 Vue 3 项目并进入项目目录 `cd vite-plugin-sdk`。接着,在 `src` 目录下创建插件文件(如 `myPlugin.js`),并在 `main.js` 中引入和使用该插件。然后,修改 `vite.config.js` 文件以配置打包选项。最后,运行 `npm run build` 进行打包,生成的 `my-plugin-sdk.js` 即为 JS SDK,可在其他项目中引入使用。
|
7天前
|
JavaScript 开发者
彻底搞懂 Vue3 中 watch 和 watchEffect是用法
彻底搞懂 Vue3 中 watch 和 watchEffect是用法
|
14天前
|
JavaScript API
如何使用Vue3的可计算属性
【9月更文挑战第5天】如何使用Vue3的可计算属性
44 13
|
5天前
|
JavaScript 调度
Vue3 使用 Event Bus
Vue3 使用 Event Bus
10 1
|
5天前
|
JavaScript
Vue3 : ref 与 reactive
Vue3 : ref 与 reactive
9 1