@mux/playback-core

What is @mux/playback-core?

@mux/playback-core is a JavaScript library designed to facilitate the integration of Mux video playback into web applications. It provides a set of tools and utilities to handle video playback, including features like adaptive bitrate streaming, low-latency playback, and detailed analytics.

What are @mux/playback-core's main functionalities?

Basic Video Playback

This feature allows you to set up basic video playback using a Mux playback ID. The code initializes a new player instance and attaches it to a video element in the DOM.

const mux = require('@mux/playback-core');
const player = mux.Player({
  playbackId: 'your-playback-id',
  autoplay: true,
  muted: false
});
player.attach('#video-element');

Adaptive Bitrate Streaming

This feature enables adaptive bitrate streaming, which adjusts the video quality in real-time based on the user's network conditions. The code initializes the player with adaptive streaming enabled.

const mux = require('@mux/playback-core');
const player = mux.Player({
  playbackId: 'your-playback-id',
  autoplay: true,
  muted: false,
  adaptive: true
});
player.attach('#video-element');

Low-Latency Playback

This feature allows for low-latency playback, which is crucial for live streaming scenarios. The code initializes the player with low-latency mode enabled.

const mux = require('@mux/playback-core');
const player = mux.Player({
  playbackId: 'your-playback-id',
  autoplay: true,
  muted: false,
  lowLatency: true
});
player.attach('#video-element');

Detailed Analytics

This feature provides detailed analytics about the video playback, such as buffering events, playback quality, and user interactions. The code sets up an event listener to log playback data.

const mux = require('@mux/playback-core');
const player = mux.Player({
  playbackId: 'your-playback-id',
  autoplay: true,
  muted: false
});
player.attach('#video-element');
player.on('playback', (data) => {
  console.log('Playback data:', data);
});

Other packages similar to @mux/playback-core

video.js

Video.js is a popular open-source HTML5 video player that supports a wide range of video formats and provides features like adaptive bitrate streaming, custom skins, and plugins. Compared to @mux/playback-core, Video.js is more general-purpose and not specifically tailored for Mux services.

hls.js

Hls.js is a JavaScript library that allows you to play HLS (HTTP Live Streaming) videos in browsers that do not support HLS natively. It provides features like adaptive bitrate streaming and low-latency playback. While Hls.js focuses on HLS streams, @mux/playback-core offers a broader range of features specifically designed for Mux video services.

dash.js

Dash.js is an open-source JavaScript library for playing MPEG-DASH (Dynamic Adaptive Streaming over HTTP) content. It provides features like adaptive bitrate streaming and detailed analytics. Dash.js is specialized for MPEG-DASH, whereas @mux/playback-core offers a more integrated solution for Mux video services.

README

Playback Core

This is a collection of utility functions directly related to the playback and Mux Data integration with various mux elements.

It is currently used by mux-video, mux-video-react, mux-audio, and mux-audio-react.

You shouldn't need use this package directly, but if you're building something custom for your application you may find it handy.

Check the src/index.ts file to see the functions and types that get exported.