Playlists Resource

Overview

The Playlists API allows you to obtain a HLS or MPEG DASH playlist for any file encoded in MP4 format or any job with outputs in MP4 format. If you request the playlist for a job ID with multiple outputs in MP4 format, you will receive a playlist including each of the outputs as a representation (e.g. different resolutions or different bitrates).

Endpoints

• GET /playlists/hls.m3u8: Allows obtaining a HLS playlist of one or more file(s) encoded in MP4 format by a successfully finished conversion Job.
• GET /playlists/dash.mpd: Allows obtaining a MPEG DASH playlist of one or more file(s) encoded in MP4 format by a successfully finished conversion Job.

Authentication

All endpoints require a Bearer token for authentication or an HMAC signature if the token is not provided.

Supported Methods

• GET: Retrieve HLS or MPEG DASH playlists for files or jobs encoded in MP4 format.

Headers

• Authorization: Bearer [AUTH_TOKEN] (if provided)

Common Parameters

• format: string (Optional)
  Values: json, xml
  Overrides the Request Accept header.
• human: boolean (Optional)
  Values: true, false
  If 'true', the response will be in a structured, more human-readable form.
• file_id: string (Optional)
  ID specifying one or more file(s) in the Files resource. Multiple file IDs can be provided separated by commas.
• job_id: string (Optional)
  Shortcut for selecting all the output file IDs of a given job. Equivalent to listing all output file IDs of a job comma-separated in the "file_id" parameter. The "file_id" and "job_id" parameters should not be used together. Use either "job_id" or "file_id".
• autograph_tag: string (Optional)
  A unique tag to be embedded dynamically with the resulting video stream for traceability via Xvid AutoGraph watermarking technology.
• expiry_time: int (Optional)
  Desired expiry time (in seconds since epoch) for the playlist.
• anti_fraud: boolean (Optional)
  Enables features to prevent link sharing and detect fraud.
• ip: int (Optional)
  Allows only clients with the specified IP address to retrieve the playlist. The IP must be specified as a 32-bit integer.

For detailed information about each method, please refer to the respective documentation files.