Models

VideoStreamingPlaylists

object

idid>= 1

Example

typeinteger1

Playlist type:

1: HLS

playlistUrlstring<url>

segmentsSha256Urlstring<url>

filesArray<VideoFile>

Video files associated to this playlist.

The difference with the root files property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)

Show child attributes

idid>= 1

Example

magnetUristring<uri>

magnet URI allowing to resolve the video via BitTorrent without a metainfo file

resolutionVideoResolutionConstant

resolutions and their labels for the video

Show child attributes

idVideoResolutionSet

Video resolution (0, 240, 360, 720, 1080, 1440 or 2160)

0 is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.

Example

labelstring

Example

240p

sizeinteger

Video file size in bytes

torrentUrlstring<url>

Direct URL of the torrent file

torrentDownloadUrlstring<url>

URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)

fileUrlstring<url>

Direct URL of the video

playlistUrlstring<url>

Playlist URL of the file if it is owned by a playlist

fileDownloadUrlstring<url>

URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)

fpsnumber

Frames per second of the video file

widthnumber

PeerTube >= 6.1 Video stream width

heightnumber

PeerTube >= 6.1 Video stream height

metadataUrlstring<url>

URL dereferencing the output of ffprobe on the file

hasAudioboolean

PeerTube >= 6.2 The file container has an audio stream

hasVideoboolean

PeerTube >= 6.2 The file container has a video stream

storageFileStorage01

The file storage type:

0 File system
1 Object storage

redundanciesArray<object>

Show child attributes

baseUrlstring<url>

Example

{
  "id": 42,
  "type": 1,
  "playlistUrl": "https://example.com",
  "segmentsSha256Url": "https://example.com",
  "files": [
    {
      "id": 42,
      "magnetUri": "https://example.com",
      "resolution": {
        "id": 240,
        "label": "240p"
      },
      "size": 0,
      "torrentUrl": "https://example.com",
      "torrentDownloadUrl": "https://example.com",
      "fileUrl": "https://example.com",
      "playlistUrl": "https://example.com",
      "fileDownloadUrl": "https://example.com",
      "fps": 0,
      "width": 0,
      "height": 0,
      "metadataUrl": "https://example.com",
      "hasAudio": true,
      "hasVideo": true,
      "storage": 0
    }
  ],
  "redundancies": [
    {
      "baseUrl": "https://example.com"
    }
  ]
}

Docs by Sourcey