Marecchia NPM Package 📦

Enhance your HLS streaming experience with Marecchia, a TypeScript library that brings peer-to-peer (P2P) capabilities to HLS streams.

Through the power of a WebAssembly (WASM) module written in Rust, Marecchia efficiently manages P2P networking, optimizing bandwidth and improving streaming quality.

[!IMPORTANT] This README covers the setup and usage of the Marecchia NPM package. For details on setting up the tracker backend, please refer to the separate README in the crates/marecchia-tracker directory.

Features 🚀

• P2P-Enabled HLS Streaming: Offload your server's load by distributing streaming data across viewers.
• WASM-Powered Performance: Benefit from a high-performance WASM module that handles all P2P logic.
• Seamless Integration: Easily integrates with existing HLS.js projects through the P2PFragmentLoader class.
• Automatic Fallback: Ensures uninterrupted streaming by defaulting to HTTP loading if P2P connectivity fails.

Installation 💾

Add Marecchia to your project using npm:

npm install marecchia

Getting Started 🌱

To get started with Marecchia, ensure your project is already utilizing HLS.js. Marecchia serves as an extension to HLS.js, adding P2P functionality.

Usage 🔧

Below is a basic guide on how to integrate Marecchia into your HLS.js setup:

1. Import in Your Project:

import Hls from 'hls.js';
import { P2PFragmentLoader } from 'marecchia';

2. Configure HLS.js to Use Marecchia:

// Ensure HLS.js is supported in the user's browser
if (Hls.isSupported()) {
    const video = document.getElementById('video');
    const hls = new Hls({
        // Configure Marecchia's P2PFragmentLoader as the loader
        loader: P2PFragmentLoader,
    });

    // Load your .m3u8 source
    hls.loadSource('https://example.com/your_stream.m3u8');
    hls.attachMedia(video);

    // Play the video after the manifest is loaded
    hls.on(Hls.Events.MANIFEST_PARSED, function () {
        video.play();
    });
}

This example demonstrates how to set up HLS.js with Marecchia to start enjoying the benefits of P2P streaming.

Contribution 🤝

Contributions to Marecchia are welcome! If you have improvements or fixes, please fork the repository, make your changes, and submit a pull request. See CONTRIBUTING.md for contribution guidelines.

License 📜

Marecchia and its NPM package are under the GNU General Public License v3 (GNUv3), promoting freedom to share and change the software.