Vue.js Video Editor SDK

This CE.SDK configuration is highly customizable and extendible, offering a full suite of video editing features such as splitting, cropping, and composing clips on a timeline.

Key Capabilities of the Vue.js Video Editor SDK#

Transform

Perform operations like video cropping, flipping, and rotating.

Trim & Split

Easily set start and end times, and split videos as needed.

Merge Videos

Edit and combine multiple video clips into a single sequence.

Video Collage

Arrange multiple clips on one canvas.

Client-Side Processing

Execute all video editing operations directly in the browser, with no need for server dependencies.

Headless & Automation

Programmatically edit videos within your Vue.js application.

Extendible

Add new functionalities seamlessly using the plugins and engine API.

Customizable UI

Design and integrate custom UIs tailored to your application.

Asset Libraries

Incorporate custom assets like filters, stickers, images, and videos.

Green Screen Support

Apply chroma keying for background removal.

Templating

Create design templates with placeholders and text variables for dynamic content.

Browser Support#

Video editing mode relies on modern web codecs, supported only in the latest versions of Google Chrome, Microsoft Edge, or other Chromium-based browsers.

Prerequisites#

Ensure you have the latest stable version of Node.js & NPM installed

Supported File Types#

Creative Editor SDK supports loading, editing, and saving MP4 files directly in the browser. Additionally, the following file types can be imported for use as assets during video editing:

• MP3
• MP4 (with MP3 audio)
• M4A
• AAC
• JPG
• PNG
• WEBP

Scenes or individual assets from the video can be exported as JPG, PNG, Binary, or PDF files.

Getting Started#

If you're ready to start integrating CE.SDK into your Vue.js application, check out the CE.SDK Getting Started guide. In order to configure the editor for a video editing use case consult our video editor UI showcase and its reference implementation.

Understanding CE.SDK Architecture & API#

The sections below provide an overview of the key components of the CE.SDK video editor UI and its API architecture.

If you're ready to start integrating CE.SDK into your Vue.js application, check out our Getting Started guide or explore the Essential Guides.

CreativeEditor Video UI#

The CE.SDK video UI is designed for intuitive video creation and editing. Below are the main components and customizable elements within the UI:

• Canvas: The main interaction area for video content.
• Dock: Entry point for interactions not directly related to the selected video block, often used for accessing asset libraries.
• Canvas Menu: Access block-specific settings such as duplication or deletion.
• Inspector Bar: Manage block-specific functionalities, like adjusting properties of the selected block.
• Navigation Bar: Handles global scene actions like undo/redo and zoom.
• Canvas Bar: Provides tools for managing the overall canvas, such as adding pages or controlling zoom.
• Timeline: The core video editing control, where clips and audio are arranged over time.

Learn more about interacting with and manipulating video controls in our video editor UI guide.

CreativeEngine#

CreativeEngine is the core of CE.SDK, responsible for managing the rendering and manipulation of video scenes. It can be used in headless mode or integrated with the CreativeEditor UI. Below are key features and APIs provided by the CreativeEngine:

• Scene Management: Programmatically create, load, save, and modify video scenes.
• Block Manipulation: Create and manage video elements such as shapes, text, and images.
• Asset Management: Load assets like videos and images from URLs or local sources.
• Variable Management: Define and manipulate variables within scenes for dynamic content.
• Event Handling: Subscribe to events such as block creation or updates for dynamic interaction.

API Overview#

The APIs of CE.SDK are grouped into several categories, reflecting different aspects of scene management and manipulation.

Scene API:

• Creating and Loading Scenes:

  JavaScript

  engine.scene.create();
  engine.scene.loadFromURL(url);

• Zoom Control:

  JavaScript

  engine.scene.setZoomLevel(1.0);
  engine.scene.zoomToBlock(blockId);

Block API:

• Creating Blocks:

  JavaScript

  const block = engine.block.create('shapes/star');

• Setting Properties:

  JavaScript

  engine.block.setColor(blockId, 'fill/color', { r: 1, g: 0, b: 0, a: 1 });
  engine.block.setString(blockId, 'text/content', 'Hello World');

• Querying Properties:

  JavaScript

  const color = engine.block.getColor(blockId, 'fill/color');
  const text = engine.block.getString(blockId, 'text/content');

Variable API:

Variables allow dynamic content within scenes to programmatically create variations of a design.

• Managing Variables:

  JavaScript

  engine.variable.setString('myVariable', 'value');
  const value = engine.variable.getString('myVariable');

Asset API:

• Managing Assets:

  JavaScript

  engine.asset.add('image', 'https://example.com/image.png');

Event API

• Subscribing to Events:

  JavaScript

  // Subscribe to scene changes
  engine.scene.onActiveChanged(() => {
    const newActiveScene = engine.scene.get();
  });

Customizing the Vue.js Video Editor#

CE.SDK provides extensive customization options to adapt the UI to various use cases. These options range from simple configuration changes to more advanced customizations involving callbacks and custom elements.

Basic Customizations#

• Configuration Object: When initializing the CreativeEditor, you can pass a configuration object that defines basic settings such as the base URL for assets, the language, theme, and license key.

  JavaScript

  const config = {
    baseURL: 'https://cdn.img.ly/packages/imgly/cesdk-engine/1.18.0/assets',
    license: 'your-license-key',
    locale: 'en',
    theme: 'light'
  };

• Localization: Customize the language and labels used in the editor to support different locales.

  JavaScript

  const config = {
    i18n: {
      en: {
        variables: {
          my_custom_variable: {
            label: 'Custom Label'
          }
        }
      }
    }
  };

• Custom Asset Sources: Serve custom video or image assets from a remote URL.

UI Customization Options#

• Theme: Choose between predefined themes such as 'dark' or 'light'.

  JavaScript

  const config = {
    theme: 'dark'
  };

• UI Components: Enable or disable specific UI components based on your requirements.

  JavaScript

  const config = {
    ui: {
      elements: {
        toolbar: true,
        inspector: false
      }
    }
  };

Advanced Customizations#

Learn more about extending editor functionality and customizing its UI to your use case by consulting our in-depth customization guide. Here is an overview of the APIs and components available to you.

Order APIs#

Customization of the web editor's components and their order within these locations is managed through specific Order APIs, allowing the addition, removal, or reordering of elements. Each location has its own Order API, e.g., setDockOrder, setCanvasMenuOrder, setInspectorBarOrder, setNavigationBarOrder, and setCanvasBarOrder.

Layout Components#

CE.SDK provides special components for layout control, such as ly.img.separator for separating groups of components and ly.img.spacer for adding space between components.

Registration of New Components#

Custom components can be registered and integrated into the web editor using builder components like buttons, dropdowns, and inputs. These components can replace default ones or introduce new functionalities, deeply integrating custom logic into the editor.

Feature API#

The Feature API enables conditional display and functionality of components based on the current context, allowing for dynamic customization. For example, you can hide certain buttons for specific block types.

Plugins#

Customize the CE.SDK web editor during initialization using the outlined APIs. For many use cases, this is sufficient, but for more advanced scenarios, plugins are useful. Follow our guide on building plugins or explore existing plugins like:

Background Removal: Adds a button to the canvas menu to remove image backgrounds.

Vectorizer: Adds a button to the canvas menu to quickly vectorize a graphic.

Framework Support#

CreativeEditor SDK’s video editing library is compatible with any Javascript including, React, Angular, Vue.js, Svelte, Blazor, Next.js, Typescript. It is also compatible with desktop and server-side technologies such as electron, PHP, Laravel and Rails.

500M+

video and photo creations are powered by IMG.LY every month