MUmuxinc
Streaming

Retrieve HLS manifest

Changed on

Fetch an HLS (HTTP Live Streaming) playlist for the specified video asset, with optional query parameters to modify playback behavior.

get/{PLAYBACK_ID}.m3u8

Request

  • Base URL
    https://stream.mux.com
  • Auth
    none declared

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

Query parameters

tokenstring

Signed token (JWT) for secure video playback.

redundant_streamsboolean

Include HLS redundant streams in the manifest.

roku_trick_playboolean

Add support for timeline hover previews on Roku devices.

default_subtitles_langstring

Set the default subtitles/captions language (BCP47 compliant language code).

max_resolution'270p' | '360p' | '480p' | '540p' | '720p' | '1080p' | '1440p' | '2160p'

Set the maximum resolution of renditions included in the manifest.

min_resolution'270p' | '360p' | '480p' | '540p' | '720p' | '1080p' | '1440p' | '2160p'

Set the minimum resolution of renditions included in the manifest.

rendition_order'desc'

Set the logic to order renditions in the HLS manifest.

program_start_timeinteger

Set the start time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

program_end_timeinteger

Set the end time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

asset_start_timenumber float

Set the relative start time of the asset (in seconds) when using the instant clipping feature.

asset_end_timenumber float

Set the relative end time of the asset (in seconds) when using the instant clipping feature.

exclude_pdtboolean

If set to true, EXT-X-PROGRAM-DATE-TIME tags will be omitted from HLS manifests for assets from live streams.

Response

HLS playlist retrieved successfully.

Changes

  • 92aac9f20a74Revision changes
    • warning

      deleted the query request parameter TOKEN

    • info

      added the new optional query request parameter token

  • 5b4b3133f27dRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status