Getting Started Guide
Getting Started with MediaX
Learn how MediaX simplifies media processing with declarative pipelines and event-driven architecture.
Overview
MediaX is a TypeScript-first media processing toolkit built on top of FFmpeg. It abstracts the complexity of FFmpeg commands into a declarative, chainable API with full event-driven progress tracking.
It is designed for:
Developers who want simplified FFmpeg integration without sacrificing flexibility
Workflows requiring conversion, compression, clipping, thumbnails, audio extraction, concatenation, watermarks, GIFs, and more
Production-ready pipelines with consistent progress tracking, error handling, and metadata extraction
Key Features
Declarative Pipelines
Chain multiple steps like convert → compress → thumbnail → audio extraction
Event-driven
Listen to progress, done, error, and metadata events in real-time
Type-safe
Built with TypeScript for strong typing and IntelliSense support
Why MediaX?
✗
Without MediaX
- •Write long ffmpeg commands
- •Handle inconsistent progress parsing
- •Manage temp files and output assignment manually
With MediaX
- One pipeline API handles everything
- Events give real-time feedback
- Automatic output handling prevents errors
- Works seamlessly with Node.js (ESM + CJS) + TypeScript
Example Use Cases
Video platforms generating thumbnails, previews, compressed outputs, and extracted audio
Automated pipelines for batch processing media assets
Developer tools for video editing, GIF conversion, and metadata inspection
Educational projects to learn media pipelines & FFmpeg
Ready to Start Building?
Now that you understand what MediaX can do, let's get it installed and running in your project.