Mux

The Mux Developer Hub

Welcome to the Mux developer hub. You'll find comprehensive guides and documentation to help you start working with Mux as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Playback Modifiers

Playback Modifiers are optional parameters added to the video playback URL. These modifiers allow you to change the behavior of the stream you receive from Mux.

How to add Playback Modifiers

Mux Video supports 2 different types of playback policies: public and signed. Playback modifiers are supported for both types of playback policies. Although, the method to add them differs.

Query String with public playback URL

https://stream.mux.com/{PLAYBACK_ID}.m3u8?{MODIFIER_NAME}={MODIFIER_VALUE}

Replace PLAYBACK_ID with your asset's public policy playback ID. Replace MODIFIER_NAME and MODIFIER_VALUE to any of the supported modifiers listed below in this document.

JWT Claim with signed playback URL

https://stream.mux.com/{PLAYBACK_ID}.m3u8?token={TOKEN}

Replace PLAYBACK_ID with your asset's signed policy playback ID and TOKEN with the signature generated using Signed URL and adding modifiers to your claims body in the JWT payload.

{
  sub : "{PLAYBACK_ID}",
  aud : "{AUDIENCE_TYPE}",
  exp : "{EXPIRATION_TIME}",
  MODIFIER_NAME : "{MODIFIER_VALUE}"
}

Replace MODIFIER_NAME and MODIFIER_VALUE with any of the supported modifiers listed below in this document.

Supported Playback Modifiers

Name

Value

Intended Application

redundant_streams

true or false

Default: false

Video

Redundant Streams

Mux Video streams are delivered using multiple CDNs. The best performing CDN is selected for the viewer initiating the playback. Video is then streamed by that CDN. When the selected CDN has a transient or regional failure, the viewer's playback experience could be interrupted for the duration of the failure. General suggestion to developers is to always handle such failure scenarios and the application should re-initiate the playback session. Mux Video's CDN selection logic would then select a different CDN for streaming.

The redundant streams modifier allows Mux to list each rendition for every CDN in the HLS manifest. The order is based on CDN performance with the best performing one listed first. Video players are then capable of automatically switching to the next CDN on the list during a failure without interrupting the playback.

This modifier should reduce the development effort for developers to handle failure scenarios.

For more information on the Redundant Streams playback modifier, see this blog post.

Compatible video players

This table shows the support of various video players for redundant streams. This table will be updated as more players are tested or updated. If your player isn't listed here, please reach out, and we'll help where we can!

Player Name

Player Version

Manifest 4XX

Manifest 5XX

Media 4XX

Media 5XX

Video.js

= 7.6.6

HLS.js

= 0.14.11

JWPlayer

Production Release Channel

Safari iOS (AVPlayer)

= iOS 13.6.1

Safari MacOS

Safari >= 13.1.2
MacOS 10.15.X

Updated 8 days ago

Playback Modifiers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.