Getting started

Install

npm install longpipe

That’s it — model weights stream from cdn.longpipe.dev on first init, so no extra setup. (If you’d rather host weights yourself, see Self-hosting weights.)

Requirements

Your first effect

import { EffectsPipeline } from 'longpipe'

// Get any MediaStream — webcam, captureStream(), getDisplayMedia(), whatever
const camera = await navigator.mediaDevices.getUserMedia({ video: true })

const pipeline = new EffectsPipeline(camera, {
  background: 'blur',  // 'blur' | 'none' | image URL | ImageBitmap | { color: '#0a3' } | ...
})

// pipeline.stream is a MediaStream — use it anywhere you'd use the original
videoElement.srcObject = pipeline.stream
await pipeline.ready

What’s happening

  1. The constructor returns synchronously. pipeline.stream is available immediately and emits passthrough until init completes.
  2. The SDK spawns a worker, picks the best model preset for your GPU (autotune), fetches weights, and starts compositing.
  3. await pipeline.ready resolves when the model is attached and the effect is live. It resolves with { backend, dtype, preset }; backend is 'none' if the device has no usable GPU, in which case the stream carries the raw camera.

Next steps