VIvimeo
Videos\Text tracks

Get all the text tracks of a video

Changed on

This method returns all the text tracks of the specified video.

get/videos/{video_id}/texttracks

Request

  • Base URL
    https://api.vimeo.com
  • Auth
    OAuth 2
    Authorization code/oauth/authorize, token URL /oauth/access_token
    Client credentialsToken URL /oauth/authorize/client
    Scopescreate, delete, edit, email, interact, private, promo_codes, public, purchase, purchased, stats, upload, video_files
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

video_idnumber required
Example:258684937

The ID of the video.

Response

The text tracks were returned.

activeboolean required

Whether this text track is active.

hls_linkstring required

The read-only URL of the text track file, intended for use with HLS playback.

hls_link_expires_timestring required

The time in ISO 8601 format when the read-only HLS playback text track file expires.

languagestring nullable required

The language code for this text track. To see a full list, request /languages?filter=texttrack.

linkstring required

The read-only URL of the text track file. You can upload to this link when you create it for the first time.

link_expires_timestring required

The time in ISO 8601 format when the text track link expires.

namestring nullable required

The descriptive name of this text track.

type'captions' | 'subtitles' nullable required

The type of the text track:

Option descriptions:

  • captions - The text track is for captions.
  • subtitles - The text track is for subtitles.
uristring required

The relative URI of the text track.

Example response

[
  {
    "active": true,
    "hls_link_expires_time": "1494888499",
    "language": "en-US",
    "link_expires_time": "1494888499",
    "name": "English Subtitles",
    "type": "captions",
    "uri": "/videos/258684937/texttracks/12345"
  }
]

Changes