getPublicItemMediaFiles

v1.0.0

Get the free / public video files associated with an item given maximum resolution, device type and one or more delivery types.

Returns an array of video file objects which each include a url to a video.

The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries.

If you specify multiple delivery types, then the response array will insert types in the order you specify them in the query. For example stream,progressive would return an array with 0 or more stream files followed by 0 or more progressive files.

If no files are found a 404 is returned.

Input

{
  "type": "object",
  "properties": {
    "delivery": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "stream",
          "progressive",
          "download"
        ]
      }
    },
    "device": {
      "type": "string"
    },
    "ff": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "idp",
          "ldp",
          "hb",
          "rpt",
          "cas",
          "lrl",
          "cd"
        ]
      }
    },
    "formats": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "mp4",
          "mpd",
          "hls",
          "external"
        ]
      }
    },
    "id": {
      "type": "string"
    },
    "lang": {
      "type": "string"
    },
    "resolution": {
      "type": "string",
      "enum": [
        "HD-4K",
        "HD-1080",
        "HD-720",
        "SD",
        "External"
      ]
    },
    "segments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sub": {
      "type": "string"
    }
  },
  "required": [
    "delivery",
    "id",
    "resolution"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "name",
      "deliveryType",
      "url",
      "drm",
      "format",
      "resolution",
      "width",
      "height",
      "language"
    ],
    "properties": {
      "channels": {
        "type": "integer",
        "format": "int32",
        "description": "The number of audio channels."
      },
      "deliveryType": {
        "type": "string",
        "description": "The way in which the media file is delivered.",
        "enum": [
          "Stream",
          "Progressive",
          "Download"
        ]
      },
      "drm": {
        "type": "string",
        "description": "The type of drm used to encrypt the media. 'None' if unencrypted."
      },
      "format": {
        "type": "string",
        "description": "The format the media was encoded in."
      },
      "height": {
        "type": "integer",
        "format": "int32",
        "description": "The height of the video media."
      },
      "language": {
        "type": "string",
        "description": "The language code for the media, e.g. 'en'."
      },
      "name": {
        "type": "string",
        "description": "The name of the media file."
      },
      "resolution": {
        "type": "string",
        "description": "The resolution of the video media.",
        "enum": [
          "SD",
          "HD-720",
          "HD-1080",
          "HD-4K",
          "External",
          "Unknown"
        ]
      },
      "url": {
        "type": "string",
        "format": "uri",
        "description": "The url to access the media file."
      },
      "width": {
        "type": "integer",
        "format": "int32",
        "description": "The width of the video media."
      }
    },
    "additionalProperties": false
  }
}