Skip to main content

Introduction

Welcome to the Zvid Package documentation! This powerful Node.js library enables you to generate videos programmatically from JSON configurations using FFmpeg.

What is Zvid Package?​

The Zvid Package is a comprehensive solution for creating dynamic videos through code. Instead of manually editing videos, you can define your video composition in JSON format and let the package handle the complex FFmpeg operations.

Key Features​

🎬 Multi-Media Support

  • Video clips with precise timing control
  • Static images with positioning and effects
  • Animated GIFs seamlessly integrated
  • Custom HTML overlays with rich styling
  • SVG shapes and vector graphics

🎵 Audio Integration

  • Background music mixing
  • Sound effects layering
  • Volume control
  • Audio synchronization

✨ Advanced Effects

  • Smooth transitions between elements
  • Animation effects (fade, slide, zoom)
  • Image filters (brightness, contrast, blur)
  • Chroma key (green screen) support
  • Custom positioning and rotation

⚡ Performance & Flexibility

  • Optimized FFmpeg integration
  • Progress tracking during rendering
  • Multiple output formats
  • Error handling and validation

Use Cases​

  • Automated Video Generation: Create videos from templates and data
  • Social Media Content: Generate promotional videos at scale
  • Educational Content: Combine text, images, and narration
  • Marketing Videos: Dynamic product showcases
  • Data Visualization: Transform data into video presentations

How It Works​

  1. Define Your Project: Create a JSON configuration with your video specifications
  2. Add Elements: Include videos, images, SVGs, text, HTML, and audio with timing and positioning
  3. Apply Effects: Configure transitions, animations, and filters
  4. Render: Let the package generate your video using FFmpeg
import renderVideo from "video-rendering";

const project = {
  name: "my-video",
  width: 1920,
  height: 1080,
  duration: 10,
  frameRate: 30,
  backgroundColor: "#000000",
  visuals: [
    /* your elements */
  ],
  audios: [
    /* your audio tracks */
  ],
};

await renderVideo(project, "./output");

Prerequisites​

Before getting started, ensure you have:

  • Node.js 18.0+: The runtime environment
  • FFmpeg: The multimedia processing engine
  • Basic JavaScript/TypeScript knowledge: For configuration and integration

What's Next?​

Ready to start creating videos? Here's your learning path:

  1. Installation - Set up the package and dependencies
  2. Quick Start - Create your first video in minutes
  3. API Reference - Explore all available options
  4. Examples - Learn through practical examples

Community & Support​

  • 📖 Documentation: Comprehensive guides and API reference
  • 🐛 Issues: Report bugs and request features on GitHub
  • 💬 Discussions: Get help from the community
  • 📦 npm: Download and install the latest version

Let's start building amazing videos with code! 🚀