Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Rust

The primary, always-first-class API. Every capability is reachable from native crates on crates.io (mediaway, mediaway-encoder, mediaway-decoder, mediaway-device, mediaway-container, the *-core format crates, …).

Install

cargo add mediaway            # umbrella: pipeline + platform dispatch + re-exports
# or a specific capability / freestanding core:
cargo add mediaway-encoder mediaway-container iso-bmff ogg-core

Runnable examples live in the workspace examples/ directory, grouped by capability:

CapabilityExampleRun
Containercontainer/mux_demux_mp4.rscargo run --example mux_demux_mp4
Encodeencode/encode_h264.rscargo run --example encode_h264
Decodedecode/decode_h264.rscargo run --example decode_h264
Devicedevice/capture_camera.rs · capture_microphone.rs · capture_screen.rs · capture_window.rscargo run --example capture_screen
Pipelinepipeline/encode_to_mp4.rs · screen_record.rs · trim_and_splice.rscargo run --example screen_record

The guides in this book walk through the same flows with annotated code:

API reference: Crate Docs (docs.rs).