mux-data
Options for the Mux Data component that monitors playback quality
Adds Mux Data monitoring to the player’s media. It renders nothing — place it inside the player as a sibling of the media element. See Mux Data for how monitoring works.
Anatomy
import { MuxData } from '@videojs/react/media/mux-data';
<MuxData /><mux-data></mux-data>Register the element by importing @videojs/html/media/mux-data.
Options
| Prop | Type | Description |
|---|---|---|
envKey |
string |
Mux Data environment key the beacons are sent to. Optional for Mux-hosted playback |
metadata |
object |
Mux Data metadata for the view |
playerSoftwareName |
string |
Player name reported to Mux Data |
playerSoftwareVersion |
string |
Player version reported to Mux Data. Defaults to the Video.js version |
playerInitTime |
number |
Epoch milliseconds the player was initialized. Defaults to when the component was created |
beaconCollectionDomain |
string |
Custom domain the beacons are sent to |
disableCookies |
boolean |
Stops the SDK from setting cookies |
debug |
boolean |
Turns on SDK debug logging |
MuxDataSdk |
object |
SDK used for monitoring. Set it to undefined to switch monitoring off |
| 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 element 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.
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.