PATCH
/
players
/
{PLAYER_ID}
curl --request PATCH \
  --url https://api.vidbeo.com/v2/players/{PLAYER_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "aspectratio": "16:9",
  "autoplay": true,
  "colour": "#ff0000",
  "controls": true,
  "buttons": "play,progress,fullscreen",
  "dnt": true,
  "keyboard": true,
  "loop": true,
  "name": "Example",
  "muted": true,
  "playsinline": true,
  "preload": true,
  "quality": "highest",
  "title": true,
  "track": "en-US"
}'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "aspectratio": "16:9",
    "autoplay": true,
    "colour": "#ff0000",
    "controls": true,
    "buttons": "play,progress,fullscreen",
    "dnt": true,
    "keyboard": true,
    "loop": true,
    "name": "Example",
    "muted": true,
    "playsinline": true,
    "preload": true,
    "quality": "highest",
    "title": true,
    "track": "en-US",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

PLAYER_ID
string
required

ID of the player

Body

application/json
aspectratio
enum<string>

Its aspect ratio. Currently we only support the most common 16:9 ratio

Available options:
16:9
autoplay
boolean

Should the player try to play on-load (many browsers block this, though setting muted as true can help)?

colour
string

Its accent colour, used for the main play button

controls
boolean

Whether controls should be shown

buttons
string

If you only want a subset of the controls shown, provide a comma-separated string of the ones to include

dnt
boolean

Should the player send analytics events?

keyboard
boolean

Support keyboard controls

loop
boolean

Should the video automatically loop and restart when it ends?

name
string

A short name for the player

muted
boolean

Should the video be muted on-load?

playsinline
boolean

If supported, should the video play inline (as opposed to immediately going fullscreen)

preload
boolean

If supported, should we buffer a small amount of video on-load to improve performance?

quality
enum<string>

We try and pick the best quality (based on the connection speed) but you can force it

Available options:
highest,
lowest
title
boolean

Should the video title be shown on-load?

track
enum<string>

If subtitles are available, this sets the language of the one to show on-load

Available options:
de-DE,
en-AU,
en-GB,
en-US,
es-ES,
fr-FR,
it-IT

Response

200 - application/json
success
boolean
required
result
object
required
links
object
required
errors
object[]
required
Delete playerList services