Player Settings

Operations dealing with video player settings for videos and channels.

Get video player settings

GET

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

Get player settings for a specific video. Returns video-specific settings merged with channel player settings.

Get video player settings

curl -X GET 'https://peertube2.cpy.re/api/v1/player-settings/videos/42?raw=false'

const response = await fetch('https://peertube2.cpy.re/api/v1/player-settings/videos/42?raw=false', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/player-settings/videos/42?raw=false')
print(response.text)

200

{
  "theme": "channel-default"
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

rawbooleanfalsequery

Return raw settings without merging channel defaults

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

Update video player settings

PUT

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

Update player settings for a specific video

Update video player settings

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.

Get channel player settings

GET

https://peertube2.cpy.re/api/v1/player-settings/video-channels/{channelHandle}

Get player settings for a video channel.

Get channel player settings

curl -X GET 'https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com?raw=false'

const response = await fetch('https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com?raw=false', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com?raw=false')
print(response.text)

200

{
  "theme": "instance-default"
}

Parameters

channelHandlestringrequiredpath

The video channel handle

rawbooleanfalsequery

Return raw settings without applying instance defaults

Response

200OKPlayerChannelSettings

successful operation

Response fields application/json

Player settings for a channel

themePlayerThemeChannelSettinginstance-defaultgalaxylucide

Player theme setting for a channel:

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

404Not Found

video channel not found

Update channel player settings

PUT

https://peertube2.cpy.re/api/v1/player-settings/video-channels/{channelHandle}

Update default player settings for a video channel.

Update channel player settings

curl -X PUT 'https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "theme": "instance-default"
}'

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

const response = await fetch('https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

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

response = requests.put(
    'https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "theme": "instance-default"
}

200

{
  "theme": "instance-default"
}

Body

application/json

Player settings update for a channel

themePlayerThemeChannelSettinginstance-defaultgalaxyluciderequired

Player theme setting for a channel:

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

Parameters

channelHandlestringrequiredpath

The video channel handle

Response

200OKPlayerChannelSettings

successful operation

Response fields application/json

Player settings for a channel

themePlayerThemeChannelSettinginstance-defaultgalaxylucide

Player theme setting for a channel:

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

404Not Found

video channel 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