Update the mp4Support of a media by ID | FastPix Developer Documentation

curl -X PATCH https://api.fastpix.com/v1/on-demand/4fa85f64-5717-4562-b3fc-2c963f66afa6/update-mp4Support \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "mp4Support": "capped_4k"
}'

{
  "success": true,
  "data": {
    "thumbnail": "https://venus-images.fastpix.dev/cf41c9f7-ece3-4efe-8d31-c6e000dc422b/thumbnail.png",
    "id": "eb56a668-0354-40c2-9233-f3197e1baabd",
    "workspaceId": "c788be40-91a5-4d2d-abf7-47398a6276a1",
    "metadata": {
      "key1": "value1"
    },
    "mediaQuality": "standard",
    "maxResolution": "1080p",
    "sourceResolution": "1080p",
    "status": "Ready",
    "mp4Support": "capped_4k",
    "sourceAccess": true,
    "playbackIds": [
      {
        "id": "cf41c9f7-ece3-4efe-8d31-c6e000dc422b",
        "accessPolicy": "public",
        "accessRestrictions": {
          "domains": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          },
          "userAgents": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          }
        }
      }
    ],
    "tracks": [
      {
        "id": "344fd5bc-82af-4d11-bc1c-785d9e6f9aef",
        "type": "video",
        "width": 1920,
        "height": 1080,
        "frameRate": "30/1",
        "status": "available"
      }
    ],
    "generatedSubtitles": [],
    "isAudioOnly": false,
    "subtitleAvailable": false,
    "duration": "00:00:10",
    "aspectRatio": "16:9",
    "createdAt": "2024-12-06T03:47:26.489888Z",
    "updatedAt": "2024-12-06T03:47:47.593400Z"
  }
}

This endpoint allows you to update the mp4Support setting of an existing media file using its media ID. You can specify the MP4 support level, such as none, capped_4k, audioOnly, or a combination of audioOnly, capped_4k, in the request payload.

How it works

Send a PATCH request to this endpoint, replacing {mediaId} with the media ID.
Provide the desired mp4Support value in the request body.
You receive a response confirming the update, including the media’s updated MP4 support status.

MP4 Support Options

none – MP4 support is disabled for this media.
capped_4k – Generates MP4 renditions up to 4K resolution.
audioOnly – Generates an M4A file that contains only the audio track.
audioOnly,capped_4k – Generates both an audio-only M4A file and MP4 renditions up to 4K resolution.

Webhook events

video.media.mp4Support.ready – Triggered when the MP4 support setting is successfully updated.

Example

Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting “mp4Support”: “capped_4k”, the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}). If you want users to stream only the audio from the media file, you can set “mp4Support”: “audioOnly”. This provides an audio-only stream URL that allows users to listen to the media without video. By setting “mp4Support”: “audioOnly,capped_4k”, both options are enabled. Users can download the MP4 video and also stream just the audio version of the media.

This endpoint allows you to update the `mp4Support` setting of an existing media file using its media ID. You can specify the MP4 support level, such as `none`, `capped_4k`, `audioOnly`, or a combination of `audioOnly`, `capped_4k`, in the request payload. #### How it works 1. Send a PATCH request to this endpoint, replacing `{mediaId}` with the media ID. 2. Provide the desired `mp4Support` value in the request body. 3. You receive a response confirming the update, including the media’s updated MP4 support status. #### MP4 Support Options - `none` – MP4 support is disabled for this media. - `capped_4k` – Generates MP4 renditions up to 4K resolution. - `audioOnly` – Generates an M4A file that contains only the audio track. - `audioOnly,capped_4k` – Generates both an audio-only M4A file and MP4 renditions up to 4K resolution. #### Webhook events - <a href="https://docs.fastpix.io/docs/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated. #### Example Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media. Related guide: <a href="https://docs.fastpix.io/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Path parameters

mediaIdstringRequiredformat: "uuid"

The unique identifier assigned to the media when created. The value must be a valid UUID.

Request

This endpoint expects an object.

mp4SupportenumRequiredDefaults to capped_4k

Determines the type of MP4 support for the media. - none: Disables MP4 support. - capped_4k: Enables MP4 downloads with resolutions up to 4K. - audioOnly: Provides an MP4 stream containing only the audio. - audioOnly,capped_4k: Enables both MP4 video downloads (up to 4K) and an audio-only stream.

Determines the type of MP4 support for the media. - **none**: Disables MP4 support. - **capped_4k**: Enables MP4 downloads with resolutions up to 4K. - **audioOnly**: Provides an MP4 stream containing only the audio. - **audioOnly,capped_4k**: Enables both MP4 video downloads (up to 4K) and an audio-only stream.

Allowed values:

Response

Media details updated successfully

successboolean

Shows the request status. Returns true for success and false for failure.

dataobject

How it works

Send a PATCH request to this endpoint, replacing {mediaId} with the media ID.
Provide the desired mp4Support value in the request body.
You receive a response confirming the update, including the media’s updated MP4 support status.

MP4 Support Options

none – MP4 support is disabled for this media.
capped_4k – Generates MP4 renditions up to 4K resolution.
audioOnly – Generates an M4A file that contains only the audio track.
audioOnly,capped_4k – Generates both an audio-only M4A file and MP4 renditions up to 4K resolution.

Webhook events

video.media.mp4Support.ready – Triggered when the MP4 support setting is successfully updated.