ioio.tv APIs

# HLS Master Manifest

API call format:

GET /broker/vod/list/<source_guid>/hls

Description

Get HLS master manifest by GUID. This call gets all available formats for HLS codec by specifying source GUID.

Precondition:

  • No authorization token is needed.
  • Mandatory elements (should be specified):
    • <source_guid> - valid source guid. Take a specific source guid using Vod list API call.

Postcondition

  • On success response code should be 200
  • On success the whole JSON body of all HLS video formats are returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/broker/vod/list/<source_guid>/hls`
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"}
[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
  "status": true,
  "data": {
    "destBucket": "<vod-destinationbucket>",
    "mediaType": "hls_master",
    "guid": "<source_guid>",
    "variants": [
      {
        "path": "<vod-destinationbucket>/sources/<source_guid>/hls/<hls_name>_1280x720p-2.5Mbps-2500000.m3u8",
        "bitRate": "2500000",
        "cdnUrl": "https://<server>sources/<source_guid>/hls/<hls_name>_1280x720p-2.5Mbps-2500000.m3u8",
        "filePath": "<source_guid>/hls/<hls_name>_1280x720p-2.5Mbps-2500000.m3u8",
        "width": 1280,
        "mediaType": "hls_manifest_720_2500000",
        "height": 720
      },
      {
        "path": "<vod-destinationbucket>/sources/<source_guid>/hls/<hls_name>_480x270p-0.4Mbps-400000.m3u8",
        "bitRate": "400000",
        "cdnUrl": "https://<server>/sources/<source_guid>/hls/<hls_name>_480x270p-0.4Mbps-400000.m3u8",
        "filePath": "<source_guid>/hls/<hls_name>_480x270p-0.4Mbps-400000.m3u8",
        "width": 480,
        "mediaType": "hls_manifest_270_400000",
        "height": 270
      },
      ......
      {
        "path": "<vod-destinationbucket>/sources/<source_guid>/hls/<hls_name>_960x540p-1.9Mbps-1900000.m3u8",
        "bitRate": "1900000",
        "cdnUrl": "https://<server>/sources/<source_guid>/hls/<hls_name>_960x540p-1.9Mbps-1900000.m3u8",
        "filePath": "<source_guid>/hls/<hls_name>_960x540p-1.9Mbps-1900000.m3u8",
        "width": 960,
        "mediaType": "hls_manifest_540_1900000",
        "height": 540
      }
    ],
    "hlsName": "<hls_name>.m3u8",
    "cdnUrl": "https://<server>/sources/<source_guid>/hls/<hls_name>.m3u8",
    "filePath": "<source_guid>/hls/<hls_name>.m3u8",
    "hlsPath": "<vod-destinationbucket>/sources/<source_guid>/hls/<hls_name>.m3u8"
  }
}

← HLS Manifest →