Player Themes

Create a player

Create a player for your video, and customise it.

post/players

Request body

namestring

Add a name for your player theme here.

textstring

RGBA color for timer text. Default: rgba(255, 255, 255, 1)

linkstring

RGBA color for all controls. Default: rgba(255, 255, 255, 1)

linkHoverstring

RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)

linkActivestring

RGBA color for the play button when hovered.

trackPlayedstring

RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)

trackUnplayedstring

RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)

trackBackgroundstring

RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)

backgroundTopstring

RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)

backgroundBottomstring

RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)

backgroundTextstring

RGBA color for title text. Default: rgba(255, 255, 255, 1)

enableApiboolean

enable/disable player SDK access. Default: true

enableControlsboolean

enable/disable player controls. Default: true

forceAutoplayboolean

enable/disable player autoplay. Default: false

hideTitleboolean

enable/disable title. Default: false

forceLoopboolean

enable/disable looping. Default: false

Example request

{
  "name": "My nice theme",
  "assets": {
    "logo": "https://cdn.api.video/player/pl14Db6oMJRH6SRVoOwORacK/logo.png",
    "link": "https://api.video"
  },
  "shapeMargin": 10,
  "shapeRadius": 3,
  "shapeAspect": "flat",
  "shapeBackgroundTop": "rgba(50, 50, 50, .7)",
  "shapeBackgroundBottom": "rgba(50, 50, 50, .8)",
  "text": "rgba(255, 255, 255, .95)",
  "link": "rgba(255, 0, 0, .95)",
  "linkHover": "rgba(255, 255, 255, .75)",
  "linkActive": "rgba(255, 0, 0, .75)",
  "trackPlayed": "rgba(255, 255, 255, .95)",
  "trackUnplayed": "rgba(255, 255, 255, .1)",
  "trackBackground": "rgba(0, 0, 0, 0)",
  "backgroundTop": "rgba(72, 4, 45, 1)",
  "backgroundBottom": "rgba(94, 95, 89, 1)",
  "backgroundText": "rgba(255, 255, 255, .95)",
  "language": "en",
  "enableApi": true,
  "enableControls": true,
  "forceAutoplay": false,
  "hideTitle": false,
  "forceLoop": false
}

Response

Created

namestring

The name of the player theme

textstring

RGBA color for timer text. Default: rgba(255, 255, 255, 1)

linkstring

RGBA color for all controls. Default: rgba(255, 255, 255, 1)

linkHoverstring

RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)

linkActivestring

RGBA color for the play button when hovered.

trackPlayedstring

RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)

trackUnplayedstring

RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)

trackBackgroundstring

RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)

backgroundTopstring

RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)

backgroundBottomstring

RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)

backgroundTextstring

RGBA color for title text. Default: rgba(255, 255, 255, 1)

enableApiboolean

enable/disable player SDK access. Default: true

enableControlsboolean

enable/disable player controls. Default: true

forceAutoplayboolean

enable/disable player autoplay. Default: false

hideTitleboolean

enable/disable title. Default: false

forceLoopboolean

enable/disable looping. Default: false

playerIdstring required

createdAtstring date-time

When the player was created, presented in ATOM UTC format.

updatedAtstring date-time

When the player was last updated, presented in ATOM UTC format.

Example response

{
  "trackUnplayed": "trackUnplayed",
  "backgroundTop": "backgroundTop",
  "link": "link",
  "trackPlayed": "trackPlayed",
  "linkHover": "linkHover",
  "backgroundBottom": "backgroundBottom",
  "enableControls": true,
  "backgroundText": "backgroundText",
  "enableApi": true,
  "forceAutoplay": true,
  "trackBackground": "trackBackground",
  "createdAt": "2020-01-31T10:17:47Z",
  "assets": {
    "link": "path/to/my/logo/mylogo.jpg",
    "logo": "mylogo.jpg"
  },
  "hideTitle": true,
  "name": "name",
  "text": "text",
  "linkActive": "linkActive",
  "forceLoop": true,
  "playerId": "pl45KFKdlddgk654dspkze",
  "updatedAt": "2020-01-31T10:18:47Z"
}

Changes

Changed in 3 of the 50 revisions of this API.36

Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f8833See the full diff
- ●
  the optional response header X-RateLimit-Limit removed for the status 201
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 201
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 201
  optional-response-header-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.