ReferenceExtensions

mux-data

Options for the Mux Data extension that monitors playback quality

Adds the Mux Data extension to the player. It renders nothing — place it anywhere inside the player, and it follows whatever media the player attaches. See Mux Data for how monitoring works.

Import

pnpm add @videojs/html @videojs/mux-data

import '@videojs/html/extensions/mux-data';

Or load it from the CDN:

<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.1/extensions/mux-data.js"></script>

Anatomy

<mux-data></mux-data>

Options

Attribute	Property	Description
`env-key`	`envKey`	Mux Data environment key the beacons are sent to. Optional for Mux-hosted playback
—	`metadata`	Mux Data metadata for the view
`player-software-name`	`playerSoftwareName`	Player name reported to Mux Data
`player-software-version`	`playerSoftwareVersion`	Player version reported to Mux Data. Defaults to the Video.js version
`player-init-time`	`playerInitTime`	Epoch milliseconds the player was initialized. Defaults to when the player was created
`beacon-collection-domain`	`beaconCollectionDomain`	Custom domain the beacons are sent to
`disable-cookies`	`disableCookies`	Stops the SDK from setting cookies
`debug`	`debug`	Turns on SDK debug logging
—	`MuxDataSdk`	SDK used for monitoring. Set it to `undefined` to switch monitoring off

metadata and MuxDataSdk take objects, so they’re properties only, with no matching attribute. Set them on the element, typed as the MuxDataExtension class that @videojs/html/extensions/mux-data exports.

Changing MuxDataSdk, beaconCollectionDomain, debug, or disableCookies restarts monitoring, which ends the current view and starts a new one. The rest update the view in place.

Import

Anatomy

Options

See also