Installation Guide | Install Video Background Remover SDK

# Requirements:
# - Node.js 16+
# - FFmpeg (required for video composition)
# - VideoBGRemover API key

npm install @videobgremover/sdk

# Requirements:
# - Python 3.9+
# - FFmpeg (required for video composition)
# - VideoBGRemover API key

pip install videobgremover

import { VideoBGRemoverClient, Video, Background, Composition } from '@videobgremover/sdk'

// Check if FFmpeg is available
import { MediaContext } from '@videobgremover/sdk'
const ctx = new MediaContext()
console.log('FFmpeg available:', ctx.checkWebmSupport())

from videobgremover import VideoBGRemoverClient, Video, Background, Composition
from videobgremover import MediaContext

# Check if FFmpeg is available
ctx = MediaContext()
print('FFmpeg available:', ctx.check_webm_support())

# Using Homebrew (recommended)
brew install ffmpeg

# Verify installation
ffmpeg -version
ffprobe -version

# Using apt
sudo apt update
sudo apt install ffmpeg

# Verify installation
ffmpeg -version
ffprobe -version

# 1. Download FFmpeg from https://ffmpeg.org/download.html
# 2. Extract to a folder (e.g., C:\ffmpeg)
# 3. Add C:\ffmpeg\bin to your PATH environment variable
# 4. Verify installation:

ffmpeg -version
ffprobe -version

# Add to your Dockerfile
RUN apt-get update && apt-get install -y ffmpeg

# Or use a base image with FFmpeg
FROM node:18-alpine
RUN apk add --no-cache ffmpeg

# Set environment variable
export VIDEOBGREMOVER_API_KEY="vbr_your_api_key_here"

# Or use .env file
echo "VIDEOBGREMOVER_API_KEY=vbr_your_api_key_here" > .env

# Set environment variable
export VIDEOBGREMOVER_API_KEY="vbr_your_api_key_here"

# Or use .env file
echo "VIDEOBGREMOVER_API_KEY=vbr_your_api_key_here" > .env

// In your code
const client = new VideoBGRemoverClient(process.env.VIDEOBGREMOVER_API_KEY!)

import os
from videobgremover import VideoBGRemoverClient

# In your code
client = VideoBGRemoverClient(os.getenv("VIDEOBGREMOVER_API_KEY"))

import { VideoBGRemoverClient } from '@videobgremover/sdk'

async function test() {
  const client = new VideoBGRemoverClient(process.env.VIDEOBGREMOVER_API_KEY!)
  
  // Check credits
  const credits = await client.credits()
  console.log(`✅ API connected. Credits: ${credits.remainingCredits}`)
  
  // Check FFmpeg
  const ctx = new MediaContext()
  const hasWebm = ctx.checkWebmSupport()
  console.log(`✅ FFmpeg ready. WebM support: ${hasWebm}`)
}

test()

from videobgremover import VideoBGRemoverClient, MediaContext
import os

def test():
    client = VideoBGRemoverClient(os.getenv("VIDEOBGREMOVER_API_KEY"))
    
    # Check credits
    credits = client.credits()
    print(f"✅ API connected. Credits: {credits.remaining_credits}")
    
    # Check FFmpeg
    ctx = MediaContext()
    has_webm = ctx.check_webm_support()
    print(f"✅ FFmpeg ready. WebM support: {has_webm}")

test()