Runnable examples for both API levels of node-av:
api-*examples use the high-level API (node-av/api) —Demuxer,Decoder,Encoder,Muxer,pipeline(), … Recommended starting point for most use cases.- The remaining examples use the low-level API (
node-av/lib) — direct FFmpeg bindings. Where an example is a port of an official FFmpeg C example, the FFmpeg column links the original source for comparison. browser-*andelectron-*are small standalone projects in their own subdirectories.
Some examples expect input/output paths or a stream URL as arguments — check the header comment of each file. Generated output lands in examples/.tmp/.
| Example | FFmpeg | Low-Level API | High-Level API |
|---|---|---|---|
browser-fmp4 |
✓ | ||
browser-webrtc |
✓ | ||
electron-builder |
✓ | ||
electron-forge |
✓ | ||
api-abort-signal |
✓ | ||
api-bitstream-filter |
✓ | ||
api-context-options |
✓ | ||
api-dash |
✓ | ||
api-decoder-resample |
✓ | ||
api-device-capture |
✓ | ||
api-encode-decode |
✓ | ||
api-filter-complex |
✓ | ||
api-filter-complex-grid |
✓ | ||
api-filter-complex-typed |
✓ | ||
api-fmp4 |
✓ | ||
api-fmp4-pip |
✓ | ||
api-frame-extract |
✓ | ||
api-hw-codecs |
✓ | ||
api-hw-decode-sw-encode |
✓ | ||
api-hw-raw |
✓ | ||
api-hw-raw-output |
✓ | ||
api-hw-rtsp |
✓ | ||
api-hw-stream-custom-io |
✓ | ||
api-hw-transcode |
✓ | ||
api-hw-filter-sync |
✓ | ||
api-muxing |
✓ | ||
api-pipeline-hw-rtsp |
✓ | ||
api-pipeline-progress |
✓ | ||
api-pipeline-raw-muxing |
✓ | ||
api-probe |
✓ | ||
api-rtp |
✓ | ||
api-rtsp-backchannel |
✓ | ||
api-scaler |
✓ | ||
api-scaler-hw |
✓ | ||
api-sdp-custom |
✓ | ||
api-sdp-input |
✓ | ||
api-snapshot |
✓ | ||
api-stream-input |
✓ | ||
api-sw-decode-hw-encode |
✓ | ||
api-sw-transcode |
✓ | ||
api-webrtc-pip |
✓ | ||
api-whisper-subtitles |
✓ | ||
api-whisper-transcribe |
✓ | ||
frame-utils |
✓ | ||
avio-read-callback |
✓ | ✓ | |
avio-async-read-callback |
✓ | ||
decode-audio |
✓ | ✓ | |
decode-filter-audio |
✓ | ✓ | |
decode-filter-video |
✓ | ✓ | |
decode-video |
✓ | ✓ | |
demux-decode |
✓ | ✓ | |
encode-audio |
✓ | ✓ | |
encode-video |
✓ | ✓ | |
ffprobe-metadata |
✓ | ||
filter-audio |
✓ | ✓ | |
hw-decode |
✓ | ✓ | |
hw-encode |
✓ | ||
hw-transcode |
✓ | ||
qsv-decode |
✓ | ||
qsv-transcode |
✓ | ||
vaapi-encode |
✓ | ||
vaapi-transcode |
✓ | ||
mux |
✓ | ✓ | |
remux |
✓ | ✓ | |
resample-audio |
✓ | ✓ | |
rtsp-stream-info |
✓ | ||
scale-video |
✓ | ✓ | |
show-metadata |
✓ | ✓ | |
transcode-aac |
✓ | ✓ | |
transcode |
✓ | ✓ |