# VOD List

API call format

GET /broker/vod/list

Description

This call gets all available video sources details as array of JSON structures.

Precondition

  • No authorization token is needed.

Postcondition

  • On success response code should be 200
  • On success the whole JSON body of the available video sources is returned with details.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/broker/vod/list
[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": [
    {
      "guid": "<source_guid1>",
      "mediaType": "source",
      "meta": {
        "genre": "Cartoons",
        "description": "Moonbeam.City.S01E07.Cop.Con",
        "type": "source",
        "title": "Moonbeam.City.Cop.Con",
        "imageUrl": "https://<server>/sources/<source_guid1>/thumbnails/<image_name>.jpg"
      },
      "srcDuration": 1281300,
      "frameCapture": true,
      "srcVideo": "<file_name1>.mp4",
      "status": "complete",
      "createdAt": 1560953881000,
      "encodedAt": 1560955145000,
      "hlsUrl": "https://<server>/sources/<source_guid1>/hls/<file_name>.m3u8",
      "dashUrl": "https://<server>/sources/<source_guid1>/dash/<file_name>.mpd",
      "mp4Outputs": [
        "https://<server>/sources/<source_guid1>/mp4/<file_name1>_720p.mp4",
        "https://<server>/sources/<source_guid1>/mp4/<file_name1>_360p.mp4"
      ]
    },
    {
      "guid": "<source_guid2>",
      "mediaType": "source",
      "meta": {
        "originalFileName": "Most Epic 4K Cinematic Game Trailers Part 6 UHD-1080.mp4",
        "description": "Most Epic 4K Cinematic GameMost Epic 4K Cinematic Game",
        "title": "Most Epic 4K Cinematic Game",
        "type": "source",
        "imageUrl": "https://<server>/sources/<source_guid1>/thumbnails/<image_name>.jpg"
      },
      "srcDuration": 848202,
      "frameCapture": true,
      "srcVideo": "<file_name2>.mp4",,
      "status": "complete",
      "createdAt": 1561453743000,
      "encodedAt": 1561454406000,
      "hlsUrl": "https://<server>/sources/<source_guid2>/hls/<file_name2>.m3u8",
      "dashUrl": "https://<server>/sources/<source_guid2>/dash/<file_name2>.mpd",
      "mp4Outputs": [
        "https://<server>/sources/<source_guid1>/mp4/<file_name2>_360p.mp4"
      ]
    },
    {
      "guid": "<source_guid3>",
      "mediaType": "source",
      "meta": {
        "genre": "Trailers",
        "description": "Marvel Studios' AvengersMarvel Studios' Avengers",
        "type": "source",
        "title": "Marvel Studios' Avengers",
        "imageUrl": "https://<server>/sources/<source_guid1>/thumbnails/<image_name>.jpg"
      },
      "srcDuration": 146193,
      "frameCapture": true,
      "srcVideo": "<file_name3>.mp4",,
      "status": "complete",
      "createdAt": 1561020181000,
      "encodedAt": 1561020545000,
      "hlsUrl": "https://<server>/sources/<source_guid2>/hls/<file_name3>.m3u8",
      "dashUrl": "https://<server>/sources/<source_guid2>/dash/<file_name3>.mpd",
      "mp4Outputs": [
        "https://<server>/sources/<source_guid1>/mp4/<file_name1>_720p.mp4",
        "https://<server>/sources/<source_guid1>/mp4/<file_name1>_360p.mp4",
        "https://<server>/sources/<source_guid1>/mp4/<file_name1>_1080p.mp4"
      ]
    },
    ...
    ]
}

We shall preserve this <source_guid> for the next API calls.