npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@marecchia/hlsjs

v0.0.5

Published

A WebRTC-based P2P live streaming library on top of hls.js

Downloads

4

Readme

@marecchia/hlsjs 📦

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/hlsjs

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/hlsjs';
  1. 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.