mux-embed

What is mux-embed?

The mux-embed npm package is used to integrate Mux Data into video players for monitoring and analytics. It allows developers to track video performance, quality of experience, and viewer engagement by embedding Mux's tracking capabilities into their video players.

What are mux-embed's main functionalities?

Basic Integration

This code demonstrates how to initialize the mux-embed package with basic configuration options. It sets up the environment key, player name, video ID, title, series, duration, and stream type.

const mux = require('mux-embed');
mux.init({
  debug: true,
  data: {
    env_key: 'YOUR_ENV_KEY',
    player_name: 'My Video Player',
    player_init_time: Date.now(),
    video_id: 'video-id-12345',
    video_title: 'My Video Title',
    video_series: 'My Video Series',
    video_duration: 120000,
    video_stream_type: 'on-demand'
  }
});

Tracking Player Events

This code shows how to monitor a video element for player events using mux-embed. It attaches the Mux monitoring to a video element and provides necessary data for tracking.

const videoElement = document.getElementById('my-video');
mux.monitor(videoElement, {
  debug: true,
  data: {
    env_key: 'YOUR_ENV_KEY',
    player_name: 'My Video Player',
    video_id: 'video-id-12345',
    video_title: 'My Video Title'
  }
});

Custom Events

This code demonstrates how to emit custom events using mux-embed. It sends a custom event with specific data related to the video being tracked.

mux.emit('custom_event', {
  video_id: 'video-id-12345',
  event_name: 'custom_event_name',
  event_data: {
    key1: 'value1',
    key2: 'value2'
  }
});

Other packages similar to mux-embed

videojs-contrib-ads

The videojs-contrib-ads package is used to integrate ad support into Video.js players. While it focuses on ad integration rather than analytics, it provides similar functionality in terms of tracking ad events and player interactions.

hls.js

hls.js is a JavaScript library that allows HLS (HTTP Live Streaming) to be played in browsers. It provides extensive event tracking and monitoring capabilities for HLS streams, similar to how mux-embed tracks video performance and quality.

dash.js

dash.js is an open-source JavaScript library for playing back MPEG-DASH streams. It includes features for monitoring and tracking playback quality and performance, similar to the analytics provided by mux-embed.

README

Mux Data SDK for monitoring Video playback

Mux Data gives you insight into video engagement and Quality of Experience using client-side SDKs for your player.

This core SDK monitors HTML5 Video, Hls.js, and Dash.js. See all supported players here.

Documentation

• Monitor HTML5 Video Element
• Monitor HLS.js
• Monitor Dash.js