Package Exports

@mux/mux-player
@mux/mux-player/ads
@mux/mux-player/ads/index
@mux/mux-player/ads/index.cjs.js
@mux/mux-player/ads/index.js
@mux/mux-player/ads/mixin
@mux/mux-player/ads/mixin/index
@mux/mux-player/ads/mixin/index.cjs.js
@mux/mux-player/ads/mixin/index.js
@mux/mux-player/ads/mixin/types
@mux/mux-player/base
@mux/mux-player/base.cjs.js
@mux/mux-player/base.js
@mux/mux-player/errors
@mux/mux-player/helpers
@mux/mux-player/html
@mux/mux-player/index
@mux/mux-player/index.cjs.js
@mux/mux-player/index.js
@mux/mux-player/logger
@mux/mux-player/mux-player
@mux/mux-player/mux-player.js
@mux/mux-player/polyfills/index
@mux/mux-player/template
@mux/mux-player/themes/classic
@mux/mux-player/themes/gerwig
@mux/mux-player/themes/microvideo
@mux/mux-player/themes/minimal
@mux/mux-player/themes/news
@mux/mux-player/types
@mux/mux-player/utils
@mux/mux-player/video-api

Readme

<mux-player>

New release: 3.0

Mux Player recently released 3.0. The most visible change in this is new tooltips that are enabled by default, as well as other fixes and changes.

Previous version: 2.0

For changes relating to the previous major release, 2.0, see the V1 to V2 upgrade guide and the blog post announcement.

Introduction

<mux-player> is the official Mux-flavored video player web component.

The player UI is built on Media Chrome and <mux-video> drives the core video logic used to play Mux Video content.

Installation

npm install @mux/mux-player

yarn add @mux/mux-player

Usage

<mux-player
  playback-id="DS00Spx1CV902MCtPj5WknGlR102V5HFkDe"
  metadata-video-title="Big Buck Bunny"
  metadata-viewer-user-id="user-id-1234"
></mux-player>

Docs

Docs and guides live on docs.mux.com.

API reference lives on Github.