Vue Video Annotation


Vue3 component that allows adding annotations to videos by free drawing or adding shapes like circles, squares, and arrows.

? Installation


npm install --save vue-video-annotation

? Usage in Vue3 Components

  <VideoAnnotationPlayer :annotations="annotations"
    <template v-slot:videoContent>
      <source type="video/mp4" src="">

      <source type="video/webm" src="">

      <track kind="subtitles" label="中文字幕" srclang="zh" src="" default>
  import { VideoAnnotationPlayer, Annotation } from 'vue-video-annotation'

  export default defineComponent({
    components: {
    setup() {
        let annotations = ref<Annotation[]>([]);

        const onAnnotationAdd = (annotation: Annotation) => {

        return {
import { createApp } from 'vue'
import App from './App.vue'

//Import the style
import 'vue-video-annotation/dist/style.css'

const app = createApp(App);

? Properties

Property Type Description Default
src String Video url to be used
poster String Image url to be used before video start
autoPlay Boolean Boolean to enable autoplay false
showFullscreenButton Boolean Show/Hide fullscreen button true
showLoopButton Boolean Show/Hide loop button true
constrolsTimeout Number Value to control the timout of the controls 3000 seconds
strokeWidth Number Stroke width for annotations 5
showAnnotationControls Boolean Show/Hide annotation controls true
annotations Annotation[] Array of annoataions to be used to add/import [] required
colors String[] Array of colors to be used by the player ['#000000', '#FFFFFF', '#F44336', '#E91E63', '#9C27B0', '#673AB7', '#3F51B5', '#2196F3', '#00BCD4', '#009688', '#4CAF50', '#8BC34A', '#CDDC39', '#FFEB3B', '#FFC107', '#FF9800', '#FF5722', '#795548', '#9E9E9E', '#607D8B']

? Events

Event Description Example
annotationAdd Fired after an annotation be drawn @annotation-add="doSomething"
annotationSelected Fired after an annotation be selected @annotation-selected="doSomething"