Enable static MP4 renditions

Why enable MP4 support

Any Mux video asset can be streamed or downloaded using the MPEG-4 video (.mp4) format or audio (.m4a) format.

This allows users to download a file for watching offline which is useful for:

• Supporting very old devices, like Android < v4.0 (Less than 1% of Android users)
• Supporting assets that are very short in duration (e.g., < 10s) on certain platforms
• Embedding a video in Open Graph cards for sharing on sites like Facebook and Twitter

It also allows users to download M4A audio files, which may be useful for:

• Feeding into transcription services
• Delivering a streamable audio-only file to an audio element
• Downloading an audio-only file, useful for things like podcasts

In the majority of other cases, you'll want to use our default HLS (.m3u8) format, which provides a better viewing experience by dynamically adjusting the quality level to the viewer's connection speed. The HLS version of a video will also be ready sooner than the MP4 versions, if time-to-ready is important.

How to enable MP4 support

There is no additional cost for creating and storing MP4 files for plus and premium quality level assets.

For basic quality level assets, we do charge for MP4 storage, but encoding is free.

Delivery for MP4s has the same price-per-minute cost as HLS delivery.

Enabling MP4 support when you create an asset

You can add MP4 support to an asset when creating an assetAPI by including the "mp4_support: <option>" parameter.

The supported options are:

• capped-1080p: Produces a single MP4 file with the video resolution up to 1080p.
• audio-only: Produces a single M4A (audio-only MP4) file for a video asset.
• audio-only,capped-1080p: Produces both M4A and MP4 files for assets with video and audio, only the MP4 file for video-only assets, or only the M4A file for audio-only assets.
• standard (deprecated). Depending on the source video resolution, produces up to three MP4 files with different levels of resolution. We strongly recommend using one of the previous options, depending on your use case.

The files produced by each mp4_support option depends on the source asset type:

The standard option will always produce a low.mp4 file. The medium.mp4 and high.mp4 (780p or 1080p) files may be produced depending on the source video resolution.

Here's an example of creating an asset with mp4_support enabled using the capped-1080p option:

// POST /video/v1/assets
{
  "input": "https://storage.googleapis.com/muxdemofiles/mux.mp4",
  "playback_policy": [
    "public"
  ],
  "mp4_support": "capped-1080p"
}

Enable MP4 support after an asset has already been created

You can also add MP4 support retroactively by calling the update asset MP4 support APIAPI, as shown below.

// PUT /video/v1/assets/{ASSET_ID}/mp4-support
{
  "mp4_support": "capped-1080p"
}

If you already have an asset with the standard option enabled and want to generate new static renditions with one of the capped-1080p, audio-only or audio-only,capped-1080p options, you need to make the following two update asset MP4 support API callsAPI:

1. Update request with the mp4_support option set to none to first delete the existing static renditions
2. Update request with the mp4_support option set to one of the capped-1080p, audio-only, or audio-only,capped-1080p options

Enable MP4 support for a direct upload

To enable MP4 support for direct upload, you need to specify the same mp4_support field within new_asset_settings, as shown below:

// POST /video/v1/uploads
{
  "cors_origin": "https://example.com/",
  "new_asset_settings": {
    "playback_policy": [
      "public"
    ],
    "mp4_suport" : "capped-1080p"
  }
}

Enable MP4 support when a live stream finishes

If you want to enable MP4 support from the recorded version of a live stream soon after the live stream is finished, use the mp4_support property in the new_asset_settings when creating the live streamAPI.

// POST /video/v1/live-streams
{
  "playback_policy": "public",
  "new_asset_settings": {
    "playback_policy": "public",
    "mp4_support": "capped-1080p"
  }
}

Create the MP4 streaming URL

After adding MP4 support you'll see an additional key on the asset object called static_renditions. This is the object that will contain the information about which MP4s are available.

The static_renditions.status parameter refers to the current status of processing the MP4s. MP4s take longer to create than our default HLS version of the video, so they will not be ready immediately when the asset status is ready. Instead they will be ready when the static_renditions.status is ready, and a webhook of video.asset.static_renditions.ready is fired.

{
  ...all asset details...
  "mp4_support": "capped-1080p",
  "static_renditions": {
    "status": "preparing"
  }
}

When the static_renditions.status field is ready, you will see the details of the MP4s available in an array under the files key. The example below shows the files for the audio-only,capped-1080 option:

{
  ...all asset details...
  "mp4_support": "capped-1080p",
  "static_renditions": {
    "status": "ready",
    "files": [
      {
        "name": "audio.m4a",
        "ext": "m4a",
        "bitrate":  {M4A_BITRATE},
        "filesize":  {M4A_FILESIZE}
      },
      {
        "name": "capped-1080p.mp4",
        "ext": "mp4",
        "height": {MP4_HEIGHT},
        "width":  {MP4_WIDTH},
        "bitrate":  {MP4_BITRATE},
        "filesize":  {MP4_FILESIZE}
      }
    ]
  }
}

The MP4 or M4A streaming URL is compiled using the playback ID and one of the static_renditions.

https://stream.mux.com/{PLAYBACK_ID}/{capped-1080p.mp4, audio.m4a}
--
ex. https://stream.mux.com/abcd1234/capped-1080p.mp4
ex. https://stream.mux.com/abcd1234/audio.m4a

If you want a browser to download the MP4 file rather than attempt to stream it, you can provide a file name for the MP4 to save it via the download query parameter:

https://stream.mux.com/{PLAYBACK_ID}/{MP4_FILE_NAME}?download={FILE_NAME}
--
ex. https://stream.mux.com/abcd1234/capped-1080p.mp4?download=cats

For the deprecated standard option, the file names will be low.mp4, medium.mp4, high.mp4.

Webhooks

Your application can be automatically updated with the status of MP4 downloads for an asset through webhooks.

There are four related events you can receive.

Signed URLs with MP4 video

Mux videos have two types of playback policy, public or signed. If your playback_id is signed, you will need to also sign requests made for MP4 URLs.

You can check out how to do that in our signed URLs guide.

If you run into any trouble signing MP4 requests, please reach out to Mux Support and we'll be able to help.

Disable MP4 support

To disable MP4 support on an asset, you can use the update asset MP4 support APIsAPI, setting mp4_support to none.

// PUT /video/v1/assets/{ASSET_ID}/mp4-support
{
  "mp4_support": "none"
}