Skip to main content
PATCH
Update player

Authorizations

Authorization
string
header
required

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

Path Parameters

player_id
string
required

ID of the player

Example:

"abcde12345abcde12345a"

Body

application/json
name
string

A short name for the player

Required string length: 1 - 40
Example:

"Example"

aspectratio
enum<string>

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

Available options:
16:9
Example:

"16:9"

autoplay
boolean

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

Example:

false

colour
string

Its accent colour, used for the main play button

Pattern: ^#[a-zA-Z0-9]{6}$
Example:

"#ff0000"

controls
boolean

Whether controls should be shown

Example:

false

buttons
string

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

Example:

"play,progress,volume,time,cc,settings,fullscreen,main_play"

dnt
boolean

Should the player send analytics events?

Example:

false

keyboard
boolean

Support keyboard controls

Example:

false

loop
boolean

Should the video automatically loop and restart when it ends?

Example:

false

muted
boolean

Should the video be muted on-load?

Example:

false

playsinline
boolean

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

Example:

false

preload
boolean

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

Example:

false

quality
enum<string>

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

Available options:
highest,
lowest
Example:

"highest"

title
boolean

Should the video title be shown on-load?

Example:

false

track
enum<string>

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

Available options:
af-ZA,
ar-AE,
ar-SA,
cy-GB,
da-DK,
de-CH,
de-DE,
en-AU,
en-GB,
en-IE,
en-IN,
en-US,
es-ES,
es-US,
fa-IR,
fr-CA,
fr-FR,
ga-IE,
gd-GB,
he-IL,
hi-IN,
id-ID,
it-IT,
ja-JP,
ko-KR,
ms-MY,
nl-NL,
pt-BR,
pt-PT,
ru-RU,
ta-IN,
te-IN,
tr-TR,
zh-CN
Example:

"en-US"

Response

Player

success
boolean
required
Example:

true

result
object
required
Example:
errors
object[]
required
Example: