PlayersUpdate Player Skin

Update Player Skin

curl -X POST "https://api.5centscdn.com/v2/players/5centscdn/skins/example_string" \
  -H "X-API-Key: YOUR_API_KEY" \
  --form name=My Updated Skin \
  --form meta[showskinoninit]=1 \
  --form meta[showpip]=1 \
  --form meta[autoplay]=1 \
  --form meta[muted]=0 \
  --form meta[showcv]=0 \
  --form base=2 \
  --form meta[primaryColor]=#1a73e8 \
  --form meta[secondaryColor]=#ffffff \
  --form meta[logo][file]=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg== \
  --form meta[logo][url]=https://example.com \
  --form meta[logo][position]=top-right \
  --form meta[logo][width]=32 \
  --form meta[logo][height]=32 \
  --form meta[logo][offsetH]=10 \
  --form meta[logo][offsetV]=10 \
  --form meta[logo][padding]=5 \
  --form meta[logo][opacity]=0.9 \
  --form meta[logo][fadeDelay]=5000 \
  --form meta[logo][hideOnReady]=0 \
  --form meta[poster]=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg== \
  --form meta[endAction]= \
  --form meta[videoInfo]=0 \
  --form meta[zoomMenu]=0 \
  --form meta[rewindforwardButton]=0 \
  --form meta[contextMenu]=0 \
  --form meta[offline][offlineImage]= \
  --form meta[offline][offlineTimeout]=00:00:00 \
  --form meta[offline][offlineCountdown]=0 \
  --form meta[offline][label]= \
  --form meta[vastAd]=0 \
  --form meta[imaAd]=0 \
  --form meta[imaAdOption][adTagUrl]= \
  --form meta[vastAdOption][tagURL][]= \
  --form meta[relatedVideos][:id][url]=https://cdn.example.com/videos/sample-video.mp4 \
  --form meta[relatedVideos][:id][title]=Sample Related Video \
  --form meta[relatedVideos][:id][duration]=120 \
  --form meta[relatedVideos][:id][thumb]=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
{
  "result": "success",
  "message": "Settings Updated."
}
POST
/players/5centscdn/skins/{skinid}
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

Content-Typestring
Required

The media type of the request body

Options: multipart/form-data
namestring

Updated display name for the player skin.

meta[showskinoninit]string

Show skin controls when the player initialises. '1'=yes, '0'=no

meta[showpip]integer

Show Picture-in-Picture button. 1=yes, 0=no

meta[autoplay]integer

Automatically start playback on load. 1=enabled, 0=disabled

meta[muted]integer

Start playback muted. 1=muted, 0=unmuted

meta[showcv]integer

Show concurrent viewers count overlay. 1=yes, 0=no

basestring

Base skin template to use. Valid values: '1', '2', '3', '4', or '5'

meta[primaryColor]string

Primary brand colour in hex format.

meta[secondaryColor]string

Secondary accent colour in hex format.

meta[logo][file]string

Base64-encoded logo image in data URI format (data:image/png;base64,...).

meta[logo][url]string

URL to navigate to when the logo overlay is clicked.

meta[logo][position]string

Position of the logo overlay. One of: top-left, top-right, bottom-left, bottom-right

meta[logo][width]string

Logo width in pixels, sent as string.

meta[logo][height]string

Logo height in pixels, sent as string.

meta[logo][offsetH]string

Horizontal offset from the anchor position in pixels, sent as string.

meta[logo][offsetV]string

Vertical offset from the anchor position in pixels, sent as string.

meta[logo][padding]string

Inner padding around the logo in pixels, sent as string.

meta[logo][opacity]string

Logo opacity as string. Value between '0' (fully transparent) and '1' (fully opaque).

meta[logo][fadeDelay]string

Time in milliseconds before the logo fades out, sent as string. Use '0' to keep it always visible.

meta[logo][hideOnReady]integer

Hide logo once player is fully ready. 1=yes, 0=no

meta[poster]string

Poster image shown before playback starts, encoded as a data URI (data:image/png;base64,...).

meta[endAction]string

Action to perform when playback ends. Empty string = default behaviour. 'related' = show related videos panel.

meta[videoInfo]string

Show video info overlay. '1' = show, '0' = hide.

meta[zoomMenu]string

Show zoom menu controls. '1' = show, '0' = hide.

meta[rewindforwardButton]string

Show rewind and forward skip buttons. '1' = show, '0' = hide.

meta[contextMenu]string

Show the player context (right-click) menu. '1' = show, '0' = hide.

meta[offline][offlineImage]string

Base64-encoded image shown when the stream is offline, as a data URI (data:image/...;base64,...).

meta[offline][offlineTimeout]string

Duration to wait before showing the offline image. Format: HH:MM:SS

meta[offline][offlineCountdown]string

Show countdown timer on the offline screen. '1' = show, '0' = hide.

meta[offline][label]string

Text label shown in the overlay when the stream is offline.

meta[vastAd]string

Enable VAST ad insertion. '1' = enabled, '0' = disabled. Mutually exclusive with meta[imaAd].

meta[imaAd]string

Enable Google IMA ad insertion. '1' = enabled, '0' = disabled. Mutually exclusive with meta[vastAd].

meta[imaAdOption][adTagUrl]string

VAST/VMAP ad tag URL for IMA ad insertion. Empty string disables IMA ads.

meta[vastAdOption][tagURL][]string

VAST ad tag URL. Send up to three instances via repeated FormData.append() calls to fill each slot.

meta[relatedVideos][:id][url]string

Playback URL for a related video entry. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

meta[relatedVideos][:id][title]string

Display title for a related video entry. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

meta[relatedVideos][:id][duration]string

Duration of the related video in seconds. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

meta[relatedVideos][:id][thumb]string

Base64-encoded thumbnail for a related video entry in data URI format. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. Provide your API key in the header.

Path Parameters

Body

multipart/form-data
namestring

Updated display name for the player skin.

Example:
My Updated Skin
meta[showskinoninit]string

Show skin controls when the player initialises. '1'=yes, '0'=no

Example:
1
meta[showpip]integer

Show Picture-in-Picture button. 1=yes, 0=no

Example:
1
meta[autoplay]integer

Automatically start playback on load. 1=enabled, 0=disabled

Example:
1
meta[muted]integer

Start playback muted. 1=muted, 0=unmuted

Example:
0
meta[showcv]integer

Show concurrent viewers count overlay. 1=yes, 0=no

Example:
0
basestring

Base skin template to use. Valid values: '1', '2', '3', '4', or '5'

Example:
2
meta[primaryColor]string

Primary brand colour in hex format.

Example:
#1a73e8
meta[secondaryColor]string

Secondary accent colour in hex format.

Example:
#ffffff
meta[logo][file]string

Base64-encoded logo image in data URI format (data:image/png;base64,...).

Example:
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
meta[logo][url]string

URL to navigate to when the logo overlay is clicked.

Example:
https://example.com
meta[logo][position]string

Position of the logo overlay. One of: top-left, top-right, bottom-left, bottom-right

Example:
top-right
meta[logo][width]string

Logo width in pixels, sent as string.

Example:
32
meta[logo][height]string

Logo height in pixels, sent as string.

Example:
32
meta[logo][offsetH]string

Horizontal offset from the anchor position in pixels, sent as string.

Example:
10
meta[logo][offsetV]string

Vertical offset from the anchor position in pixels, sent as string.

Example:
10
meta[logo][padding]string

Inner padding around the logo in pixels, sent as string.

Example:
5
meta[logo][opacity]string

Logo opacity as string. Value between '0' (fully transparent) and '1' (fully opaque).

Example:
0.9
meta[logo][fadeDelay]string

Time in milliseconds before the logo fades out, sent as string. Use '0' to keep it always visible.

Example:
5000
meta[logo][hideOnReady]integer

Hide logo once player is fully ready. 1=yes, 0=no

Example:
0
meta[poster]string

Poster image shown before playback starts, encoded as a data URI (data:image/png;base64,...).

Example:
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
meta[endAction]string

Action to perform when playback ends. Empty string = default behaviour. 'related' = show related videos panel.

Example:
meta[videoInfo]string

Show video info overlay. '1' = show, '0' = hide.

Example:
0
meta[zoomMenu]string

Show zoom menu controls. '1' = show, '0' = hide.

Example:
0
meta[rewindforwardButton]string

Show rewind and forward skip buttons. '1' = show, '0' = hide.

Example:
0
meta[contextMenu]string

Show the player context (right-click) menu. '1' = show, '0' = hide.

Example:
0
meta[offline][offlineImage]string

Base64-encoded image shown when the stream is offline, as a data URI (data:image/...;base64,...).

Example:
meta[offline][offlineTimeout]string

Duration to wait before showing the offline image. Format: HH:MM:SS

Example:
00:00:00
meta[offline][offlineCountdown]string

Show countdown timer on the offline screen. '1' = show, '0' = hide.

Example:
0
meta[offline][label]string

Text label shown in the overlay when the stream is offline.

Example:
meta[vastAd]string

Enable VAST ad insertion. '1' = enabled, '0' = disabled. Mutually exclusive with meta[imaAd].

Example:
0
meta[imaAd]string

Enable Google IMA ad insertion. '1' = enabled, '0' = disabled. Mutually exclusive with meta[vastAd].

Example:
0
meta[imaAdOption][adTagUrl]string

VAST/VMAP ad tag URL for IMA ad insertion. Empty string disables IMA ads.

Example:
meta[vastAdOption][tagURL][]string

VAST ad tag URL. Send up to three instances via repeated FormData.append() calls to fill each slot.

Example:
meta[relatedVideos][:id][url]string

Playback URL for a related video entry. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

Example:
https://cdn.example.com/videos/sample-video.mp4
meta[relatedVideos][:id][title]string

Display title for a related video entry. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

Example:
Sample Related Video
meta[relatedVideos][:id][duration]string

Duration of the related video in seconds. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

Example:
120
meta[relatedVideos][:id][thumb]string

Base64-encoded thumbnail for a related video entry in data URI format. :id is a unique timestamp-based key per entry (e.g. 1714000000000).

Example:
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==

Responses

resultstring

Operation outcome.

messagestring

Human-readable description of the operation outcome.