Player Settings

Update video player settings

PUT

https://peertube2.cpy.re/api/v1/player-settings/videos/{id}

Update player settings for a specific video

curl -X PUT 'https://peertube2.cpy.re/api/v1/player-settings/videos/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "theme": "channel-default"
}'

const body = `{
  "theme": "channel-default"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/player-settings/videos/42', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "theme": "channel-default"
}'''

response = requests.put(
    'https://peertube2.cpy.re/api/v1/player-settings/videos/42',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "theme": "channel-default"
}

200

{
  "theme": "channel-default"
}

Body

application/json

Player settings update for a video

themePlayerThemeVideoSettingchannel-defaultinstance-defaultgalaxyluciderequired

Player theme setting for a video:

channel-default Use the channel default theme
instance-default Use the instance default theme
galaxy Use the galaxy theme
lucide Use the lucide theme

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKPlayerVideoSettings

successful operation

Response fields application/json

Player settings for a video

themePlayerThemeVideoSettingchannel-defaultinstance-defaultgalaxylucide

Player theme setting for a video:

channel-default Use the channel default theme
instance-default Use the instance default theme
galaxy Use the galaxy theme
lucide Use the lucide theme

404Not Found

video not found

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey