@videomatik/editor v0.2.0

Videomatik Editor SDK

This module provides access to Videomatik's Editor to be able to make some operations for videomatik through a video editor.

Installation

npm install --save @videomatik/editor

Clipper

Usage

Considering you have the follow div on your HTML:

<div id="video-clipper"></div>

You can create a video clipper using the following code:

import { Clipper } from '@videomatik/editor'

const clipper = new Clipper('#video-clipper', {
  video: 'https://storage.videomatik.com.br/videomatik-sheet/a426c1ce128.mp4',
  clips: [
    {start: 10, end: 20, selected: true},
    {start: 40, end: 60, selected: false},
    {start: 80, end: 120, selected: true},
  ],
})

This will create a new video clipper using the preset video and clips in the timeline

Events

You can listen to events and check when the editor's state was updated with the following methods:

clipper.on('ready', () => {
  console.log('The player was successfully mounted and finished loading')
})

clipper.on('change', ({ clips }) => {
  console.log('User has changed the clips to:', clips)
})

Cropper

Usage

Considering you have the follow div on your HTML:

<div id="video-cropper"></div>

You can create a video cropper using the following code:

import { Cropper } from '@videomatik/editor'

const cropper = new Cropper('#video-cropper', {
  video: 'https://storage.videomatik.com.br/videomatik-sheet/a426c1ce128.mp4',
  // Optional
  crops: [],
})

This will create a new video cropper using the preset video and clips in the timeline

Events

You can listen to events and check when the editor's state was updated with the following methods:

cropper.on('ready', ({ crops }) => {
  console.log('The player was successfully mounted and finished loading, the default crops are:', crops)
})

cropper.on('change', ({ crops }) => {
  console.log('User has changed the crops to:', crops)
})

Subtitle

Usage

Considering you have the follow div on your HTML:

<div id="video-subtitle"></div>

You can create a subtitle editor using the following code:

import { Subtitle } from '@videomatik/editor'

const subtitle = new Subtitle('#video-Subtitle', {
  video: 'https://storage.videomatik.com.br/videomatik-sheet/a426c1ce128.mp4',
  subtitles: {
    // Optional
    style: {
      "MarginV": 324,
      "Outline": 6.9,
      "Fontname": "Poppins Bold",
    },
    // Optional
    transcription: [
      {
        "end": 1.411,
        "start": 0.189,
        "words": [
          {
            "end": 0.93,
            "word": "Gente,",
            "index": 0,
            "score": 0.751,
            "start": 0.189,
            "endTime": "00:00:00,930",
            "startTime": "00:00:00,189"
          },
          {
            "end": 1.411,
            "word": "ciúme",
            "index": 1,
            "score": 0.685,
            "start": 1.01,
            "endTime": "00:00:01,411",
            "startTime": "00:00:01,010"
          }
        ],
        "length": 11,
        "endTime": "00:00:01,411",
        "startTime": "00:00:00,189"
      },
    ]
  },
})

This will create a new subtitle editor using the preset video and subtitle transcription

Events

You can listen to events and check when the editor's state was updated with the following methods:

subtitles.on('ready', ( subtitles ) => {
  console.log('The player was successfully mounted and finished loading, the default subtitles are:', subtitles)
})

subtitles.on('change', ( subtitles ) => {
  console.log('User has changed the subtitles to:', subtitles)
})

Developing

To develop and test this library, you can run:

npm run dev

This will setup building, auto-rebuilding the library once you any code is changed

npm run server

This will run a server and display the project at: http://localhost:8080/demos/

If you wish to test the library, refer to the index.html page and change it to what you want to test.

You can use __editorURL special parameter to change the intended editor iframe URL to the one on your dev server

Support

Please read the API documentation available on Videomatik's website or contact the developers through our Discord server (invite link available at our website).