/hlsjs-p2p-engine

A hls.js plugin to offload bandwidth from expensive traditional CDNs,while also maximizing a user’s viewing experience.

Primary LanguageJavaScriptMIT LicenseMIT

English | 简体中文

cdnbye logo

Save Your Bandwidth using WebRTC.

npm jsdelivr size

CDNBye hlsjs-p2p-engine implements WebRTC datachannel to scale live/vod video streaming by peer-to-peer network using bittorrent-like protocol. The forming peer network can be layed over other CDNs or on top of the origin server. Powered by hls.js, it can play HLS on any platform with many popular HTML5 players such as video.js, JWPlayer and Flowplayer. BTW, you can view how much traffic has been saved here!

Features

  • WebRTC data channels for lightweight peer-to-peer communication with no plugins
  • Support live and VOD streams over HLS protocol(m3u8)
  • Support encrypted HLS stream
  • Very easy to integrate with an existing hls.js project
  • Seamlessly fallback to normal server usage if a browser doesn't support WebRTC
  • Highly configurable for users
  • Support most popular HTML5 players such as video.js、Clappr、Flowplayer
  • Efficient scheduling policies to enhance the performance of P2P streaming
  • Use IP database to group up peers by ISP and regions
  • API frozen, new releases will not break your code

Playground

Click me!

Getting Started

Quick Start Demo

Put the quick-start.html in your web page, run it. Wait for a few seconds,then open the same page from another browser. Now you have a direct P2P connection between two browsers without plugin! The first web peer will serve as a seed, if no one else in the same channel.

Integrate to Your Hls.js Project

Simply replace the hls.js script tag like:

<script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>

with

<script src="https://cdn.jsdelivr.net/npm/cdnbye@latest"></script>

That's it!

Integrate to HTML5 Players

See demos.

Browser Support

WebRTC has already been incorporated into the HTML5 standard and it is broadly deployed in modern browsers. The compatibility of CDNBye depends on the browser support of WebRTC and Hls.js. Please note that iOS Safari "Mobile" does not support the MediaSource API.

Compatibility Chrome Firefox macOS Safari Android Wechat/QQ Opera Edge IE iOS Safari
WebRTC Datachannel
Hls.js
CDNBye

Include

Include the pre-built script of latest version bundled with hls.js(recommended):

<script src="https://cdn.jsdelivr.net/npm/cdnbye@latest"></script>

Or include the latest version without hls.js:

<script src="https://cdn.jsdelivr.net/npm/cdnbye@latest/dist/hlsjs-p2p-engine.min.js"></script>

Usage

See Usage

Player Integration

API and Configuration

See API.md

Console

Bind your domain in https://oms.cdnbye.com, where you can view p2p-related information.

Related Projects

They are using CDNBye

FAQ

We have collected some frequently asked questions. Before reporting an issue, please search if the FAQ has the answer to your problem.

Contact Us

Email: service@cdnbye.com