Video

List storyboards of a video

GET

https://peertube2.cpy.re/api/v1/videos/{id}/storyboards

PeerTube >= 6.0

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/storyboards'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/storyboards', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/videos/42/storyboards')
print(response.text)

200

{
  "storyboards": [
    {
      "storyboardPath": "string",
      "fileUrl": "string",
      "totalHeight": 0,
      "totalWidth": 0,
      "spriteHeight": 0,
      "spriteWidth": 0,
      "spriteDuration": 0
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKobject

successful operation

Response fields application/json

storyboardsArray<Storyboard>

Show child attributes

storyboardPathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

totalHeightinteger

totalWidthinteger

spriteHeightinteger

spriteWidthinteger

spriteDurationinteger

Docs by Sourcey