Sign in

v1

latestOpenAPI 3.0.02026-07-175989869.3 KB
Player Themes

Upload a logo

Upload an image file as a logo for your player. The image should fit within these constraints:

  • The image mime type must be image/jpeg or image/png. api.video recommends using png images with transparent background.
  • The image size should be a maximum of 200px width x 100px.
  • The file size should be a maximum of 100 KiB.
post/players/{playerId}/logo

Path parameters

playerIdstring required

The unique identifier for the player.

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"
}