Installation Guide

Installing MediaX

MediaX is a plug-and-play library that automatically configures FFmpeg binaries. No manual setup required!

Zero Configuration Setup

MediaX automatically handles FFmpeg installation and configuration

Automatic Binary Management

FFmpeg and FFprobe binaries are bundled and configured automatically

Cross-Platform Support

Works seamlessly on Windows, macOS, and Linux

No Manual Downloads

Skip the hassle of downloading and configuring FFmpeg manually

Instant Ready

Start processing media immediately after installation

Requirements

MediaX only requires Node.js - that's it!

Node.js ≥ 18.x
npm ≥ 9.x or pnpm/yarn

No FFmpeg Installation Required!

MediaX automatically handles all FFmpeg dependencies for you

Step 1: Install MediaX

npm

Node Package Manager

npm install mediax-sdk

yarn

Yarn Package Manager

yarn add mediax-sdk

pnpm

Performant npm

pnpm add mediax-sdk

What Happens During Installation?

  • MediaX package is installed with all dependencies
  • FFmpeg and FFprobe binaries are automatically downloaded
  • Cross-platform compatibility is configured
  • TypeScript definitions are included

Step 2: Start Using MediaX

Ready to Go!

MediaX ships with TypeScript definitions and is ready to use immediately after installation.

import { MediaX } from "mediax-sdk";

const mediaX = new MediaX();

// FFmpeg is automatically configured and ready!

Step 3: Test Your Installation

Quick Test

Run this simple test to verify MediaX is working correctly:

const mediaX = new MediaX();
console.log("MediaX is ready!");

✅ If no errors appear, MediaX is successfully installed with all FFmpeg dependencies!

Installation Complete! 🎉

MediaX is now installed with automatic FFmpeg configuration. Start processing media files immediately - no additional setup required!