api.video
  1. Players
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
      POST
    • List all active upload tokens.
      GET
    • Generate an upload token
      POST
    • Delete an upload token
      DELETE
    • Show upload token
      GET
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Players

Upload a logo

POST
/players/{playerId}/logo
Players
The uploaded image maximum size should be 200x100 and its weight should be 200KB. It will be scaled down to 30px height and converted to PNG to be displayed in the player.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ws.api.video/players/pl14Db6oMJRH6SRVoOwORacK/logo' \
--form 'file=@"mylogo.jpg"' \
--form 'link="path/to/my/logo/mylogo.jpg"'
Response Response Example
201 - Example 1
{
  "assets": {
    "link": "path/to/my/logo/mylogo.jpg",
    "logo": "mylogo.jpg"
  },
  "backgroundBottom": "rgba(94, 95, 89, 1)",
  "backgroundText": "rgba(255, 255, 255, .95)",
  "backgroundTop": "rgba(72, 4, 45, 1)",
  "enableApi": true,
  "enableControls": true,
  "forceAutoplay": false,
  "forceLoop": false,
  "hideTitle": false,
  "language": "en",
  "link": "rgba(255, 0, 0, .95)",
  "linkActive": "string",
  "linkHover": "rgba(255, 255, 255, .75)",
  "shapeAspect": "string",
  "shapeBackgroundBottom": "string",
  "shapeBackgroundTop": "string",
  "shapeMargin": 0,
  "shapeRadius": 0,
  "text": "rgba(255, 255, 255, .95)",
  "trackBackground": "rgba(0, 0, 0, 0)",
  "trackPlayed": "rgba(255, 255, 255, .95)",
  "trackUnplayed": "rgba(255, 255, 255, .1)",
  "createdAt": "2020-01-31T10:17:47.000Z",
  "playerId": "pl45KFKdlddgk654dspkze",
  "updatedAt": "2020-01-31T10:18:47.000Z"
}

Request

Path Params
playerId
string 
required
The unique identifier for the player.
Example:
pl14Db6oMJRH6SRVoOwORacK
Body Params multipart/form-data
file
file 
required
The name of the file you want to use for your logo.
Example:
mylogo.jpg
link
string 
required
The path to the file you want to upload and use as a logo.
Example:
path/to/my/logo/mylogo.jpg

Responses

🟢201Created
application/json
Body
backgroundBottom
string 
optional
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string 
optional
RGBA color for title text. Default: rgba(255, 255, 255, 1)
backgroundTop
string 
optional
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
enableApi
boolean 
optional
enable/disable player SDK access. Default: true
Default:
true
enableControls
boolean 
optional
enable/disable player controls. Default: true
Default:
true
forceAutoplay
boolean 
optional
enable/disable player autoplay. Default: false
Default:
false
forceLoop
boolean 
optional
enable/disable looping. Default: false
Default:
false
hideTitle
boolean 
optional
enable/disable title. Default: false
Default:
false
link
string 
optional
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string 
optional
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
text
string 
optional
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
trackBackground
string 
optional
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
trackPlayed
string 
optional
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string 
optional
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
assets
object 
optional
link
string 
optional
The path to the file containing your logo.
Example:
path/to/my/logo/mylogo.jpg
logo
string 
optional
The name of the file containing the logo you want to use.
Example:
mylogo.jpg
createdAt
string <date-time>
optional
When the player was created, presented in ISO-8601 format.
Example:
2020-01-31T10:17:47.000Z
linkActive
string 
optional
Deprecated
playerId
string 
optional
Example:
pl45KFKdlddgk654dspkze
shapeAspect
string 
optional
Deprecated
shapeBackgroundBottom
string 
optional
Deprecated
shapeBackgroundTop
string 
optional
Deprecated
shapeMargin
integer 
optional
Deprecated
shapeRadius
integer 
optional
Deprecated
updatedAt
string <date-time>
optional
When the player was last updated, presented in ISO-8601 format.
Example:
2020-01-31T10:18:47.000Z
🟠400Bad Request
🟠404Not Found
Modified at 2023-08-15 05:52:15
Previous
Delete logo
Next
Upload with an upload token
Built with