KOkontainer
DAM: Files

Returns the cues of a subtitle track of a DAM file

Returns the cues of a subtitle track in playback order (start time, then id). The list is cursor-paged: follow links.next, or send its page[after] values, until it is null. Cues are written as a whole set with the track, through cues or srt on create and update.

get/dam/files/{file_id}/subtitles/{subtitle_id}/cues

Request

Path parameters

file_idstring required

ID of File

subtitle_idstring required

ID of Subtitle

Query parameters

page[size]integer

Cues per page. (defaults to 500, limit is 2000) Example: page[size]=100

page[after][]integer[]

Cursor of the next page: the start_ms and id of the last cue of the previous page, as given in links.next. Omit for the first page. Example: page[after][]=4000&page[after][]=901

Response

success

Example response

{
  "data": [
    {
      "id": "901",
      "type": "file_subtitle_cue",
      "attributes": {
        "start_ms": 1000,
        "end_ms": 3500,
        "text": "Welcome to Kontainer."
      }
    }
  ],
  "meta": {
    "page": {
      "size": 500,
      "after": [
        4000,
        901
      ]
    }
  },
  "links": {
    "self": "https://example.kontainer.com/jsonapi/v1/dam/files/12/subtitles/42/cues",
    "first": "https://example.kontainer.com/jsonapi/v1/dam/files/12/subtitles/42/cues",
    "next": "https://example.kontainer.com/jsonapi/v1/dam/files/12/subtitles/42/cues?page[after][]=4000&page[after][]=901"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.