player.mux.com is updating to Video.js and accepts a shorter list of parameters. Learn which parameters were renamed, deprecated, or removed, what changes in Mux Data, and how to keep Mux Player with player=mux-player.
player.mux.com, the iframe player that Mux hosts for every playback ID, is updating to Video.js and accepts a shorter list of parameters. Most embeds keep working unchanged. This guide covers what changes and what, if anything, you need to do.
player=mux-player to keep an embed on Mux Player. We'll support player=mux-player for as long as Mux Player is in maintenance mode.disable-mux-data and poster-time. The old names still work.title, video-title, primary-color, and the autoplay values muted and any are deprecated. They still work.Autoplay=true or LOOP=true is ignored. Write autoplay=true and loop=true. This applies to Mux Player embeds too.player_software_name.For most embeds, nothing. The URL, tokens, custom domains, start time, poster, accent-color, autoplay, muted, loop, controls, resolution limits (max-resolution, min-resolution), instant clips (asset-start-time, asset-end-time), metadata-*, player.js control, and oEmbed work as before.
player=mux-player to keep the embed on Mux Player. We'll support player=mux-player for as long as Mux Player is in maintenance mode. If you need the parameter on Video.js, contact Mux support.player_software_name, update the filter (see Mux Data).The old names keep working as aliases. When a URL has both, the new name wins.
| Old name | New name | What it does |
|---|---|---|
disable-tracking | disable-mux-data | Turns off Mux Data monitoring for the embed. |
thumbnail-time | poster-time | Time in seconds of the frame used for the default poster. |
These still work, but Embed parameters lists them as deprecated. Use the replacement in new embeds.
| Parameter | Replacement |
|---|---|
title, video-title | The asset's title from Mux. |
metadata-video-title as the page title | The asset's title from Mux. metadata-video-title is still a Mux Data field. |
primary-color | accent-color. Without accent-color, primary-color is used as the accent color. |
autoplay=muted | autoplay=true&muted=true |
autoplay=any | autoplay=true. Video.js treats any the same as true: if the browser blocks autoplay with sound, the video waits for the viewer to press play. |
Set an asset's title in the Mux dashboard, or with its meta.title field when you create or update the asset. The asset's title comes first, so title and video-title only apply to assets without one.
metadata-video-title still sets video_title in Mux Data. On an asset with no title, it also sets the page title. That second use is deprecated: set the asset's title instead.
The following infrequently-used parameters are removed.
If your embed needs one of these parameters, add player=mux-player to keep it on Mux Player. We'll support player=mux-player for as long as Mux Player is in maintenance mode. If you need the parameter on Video.js, contact Mux support.
| Parameter | What to do instead |
|---|---|
volume | Set the volume from your page with player.js setVolume(). |
storyboard-src | None needed. Timeline previews come from the playback ID. For signed playback IDs, use storyboard-token. |
stream-type, default-stream-type | None needed. player.mux.com reads the stream type from the stream before the page renders. |
prefer-playback | None needed. player.mux.com chooses the playback engine for each stream. |
env-key | None needed. Views report to the Mux Data environment of the playback ID. |
crossorigin | None needed. Media requests are always anonymous. |
player.mux.com also now ignores audio, backward-seek-offset, beacon-collection-domain, cap-rendition-to-player-size, cast-receiver, debug, default-duration, default-hidden-captions, default-show-remaining-time, disable-pseudo-ended, forward-seek-offset, fullscreen-element, hotkeys, initial-bandwidth-estimate-kbps, initial-estimate-segments, live-edge-offset, logo, max-auto-resolution, max-reconnect-retries, min-preload-segments, no-muted-pref, no-tooltips, no-volume-pref, nohotkeys, placeholder, playbackrate, playbackrates, prefer-cmcd, program-end-time, program-start-time, proudly-display-mux-badge, rendition-order, secondary-color, target-live-window, theme, and type.
Video.js embeds report a different player_software_name:
| Field | Before | Video.js | Mux Player (player=mux-player) |
|---|---|---|---|
player_software_name | mux-player-iframe | videojs-html-<engine>, for example videojs-html-hlsjs | mux-player-iframe |
player_name | Not set | mux-player-iframe | mux-player-iframe |
page_type | Not set | iframe, or watchpage on the watch page | iframe, or watchpage on the watch page |
To find player.mux.com views, filter on player_name mux-player-iframe. Before the move to Video.js, player.mux.com didn't set player_name, so that filter alone misses every earlier view. To keep that history in a dashboard, alert, or export during the transition, match views where player_name is mux-player-iframe or player_software_name is mux-player-iframe.
metadata-* parameters still set Mux Data fields, such as metadata-video-id or metadata-custom-1. They can no longer override player_software_name or player_software_version.
https://player.mux.com/{PLAYBACK_ID}?player=mux-playerWith player=mux-player, the embed plays with Mux Player and reads every parameter it did before, including the removed ones. We'll support player=mux-player for as long as Mux Player is in maintenance mode. See the FAQ for what maintenance mode means. If you depend on a removed parameter, contact Mux support and tell us which one.