@mcap/browser

MCAP is a modular container format and logging library for pub/sub messages with arbitrary message serialization. It is primarily intended for use in robotics applications, and works well under various workloads, resource constraints, and durability requirements.

The @mcap/browser package provides utilities for working with MCAP files in browsers.

Usage examples

Reading MCAP files in a browser

import { loadDecompressHandlers } from "@mcap/support";
import { BlobReadable } from "@mcap/browser";
import { McapIndexedReader } from "@mcap/core";

/**
 * For <input type="file"/>, listen for "change" events.
 *
 * For drag & drop, listen for "drop" events. (Note that you must also listen for "dragover" events
 * and call event.preventDefault(), to enable listening for drop events.)
 */
async function onChangeOrDrop(event: Event) {
  let file: File | undefined;
  if (event instanceof DragEvent) {
    file = event.dataTransfer?.files[0];
    event.preventDefault();
  } else if (event.target instanceof HTMLInputElement) {
    file = event.target.files?.[0];
  } else {
    throw new Error(`Unexpected event type: ${event.type}`);
  }
  if (!file) {
    throw new Error("No file selected");
  }
  const decompressHandlers = await loadDecompressHandlers();
  const reader = await McapIndexedReader.Initialize({
    readable: new BlobReadable(file),
    decompressHandlers,
  });
}
Copy

License

@mcap/browser is licensed under the MIT License.

Stay in touch

Join our Discord community to ask questions, share feedback, and stay up to date on what our team is working on.