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

Basic Playback

When an asset is created, one or more Playback IDs are created for the asset. Playback IDs are used with to play an asset using specific permissions.{PLAYBACK_ID}.m3u8

Replace {PLAYBACK_ID} with your asset's playback ID, then follow your video player's instructions for providing a video source. (Examples Below)

Supported Formats

Mux supports playback via HLS (.m3u8) for the majority of use cases. See the HLS playback support guide for help understanding which players/platforms support HLS. In addition Mux supports playback via MP4s, as described here: MP4 Support.

Additional formats such as DASH, WebM, and others will be supported in the future.

Playback with Subtitles/Closed Captions

Subtitles/Closed Captions text tracks can be added to an asset either on asset creation or later when they are available. Mux supports SubRip Text (SRT) and Web Video Text Tracks format for ingesting Subtitles and Closed Captions text tracks. For more information on Subtitles/Closed Captions, see this blog post.

Mux includes Subtitles/Closed Captions text tracks in HLS (.m3u8) for playback. Video Players show the presence of Subtitles/Closed Captions text tracks and the languages available as an option to enable/disable and to select a language. The player can also default to the viewer's device preferences.

HLS.js video player options menu for Subtitles/Closed Captions text track

In addition, Mux also supports downloading of Subtitles/Closed Captions text tracks as "sidecar" files with MP4 playback.{PLAYBACK_ID}/text/{TRACK_ID}.vtt

Replace {PLAYBACK_ID} with your asset's playback ID and {TRACK_ID} with the unique identifier value returned when this subtitle/closed caption text track was added to this asset.

Updated 12 months ago

What's Next

Specific Player Platform Examples

Web Video Playback
iOS Video Playback


Suggested Edits are limited on API Reference Pages

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