GET Video Player Config
Overview
The following table contains important information about the GET method in regards to receiving the video player video configuration.
| GET Video Player Config | |
|---|---|
| Method | GET |
| URL or Endpoint | /player/playerId/videoId.json |
| Headers | Authorization |
| Parameters | playerId, videoId, api-version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| playerId | Yes | string | Unique id of the player. |
| videoId | Yes | string | Unique Id of the video. |
| api-version | No | string | Correct api-version. |
Request Body
The request does not contain a request body
Response
{
"projectId": "{projectId}",
"config": {
"configId": "{configId}",
"biskoId": "{biskoId}",
"recommended": false,
"recommendedId": null,
"autoplay": true,
"volume": 0.5,
"muted": true,
"loop": false,
"casting": false,
"debug": false,
"skipAmount": 1,
"highlightCurrentVideo": true,
"onHoverPlay": false,
"adsRequireInteraction": false,
"allowSeekOnLive": false,
"seekLiveAfterPause": false,
"pauseOtherVideos": true,
"focusOnAutostart": false,
"pauseOnRelatedShown": false,
"readQualities": false,
"enableGravityChange": false,
"forceSound": false,
"soundSubtitleInversion": false,
"chromeCastApplicationId": null,
"showPlayerControlsDuringVideoAdvertisement": false,
"enableHapticFeedbackOnButtonClick": false,
"enableHapticFeedbackOnPinchToZoom": false,
"usePortraitMode": null,
"showContentTitle": false,
"showContentDescription": false,
"midrollSentenceAlignment": false,
"useDevicePixelRatio": false,
"lightStreamingMode": false,
"showEngagementHeatmap": false,
"float": {
"state": false,
"onMobile": false,
"position": "{position}",
"dismissible": false,
"requiresInteraction": false,
"style": {
"width": "{width}",
"border": null
}
},
"controls": {
"theaterButton": true,
"settingsButton": true,
"chromecastButton": true,
"nextButton": true,
"fullscreenButton": true,
"airplayButton": true,
"bigPlayButton": true,
"pictureInPictureButton": false,
"volumeButton": true,
"shareButton": false,
"showHelperButton": false,
"helperButtonImage": "{helperButtonImage}",
"showLiveIcon": false,
"delayLiveVideosTime": 0,
"delayLiveVideos": false,
"showAutoPlay": false,
"showQualities": false,
"subtitlesButton": false,
"showCaptions": false,
"audioOnlyButton": false,
"rewindButton": false,
"forwardButton": false,
"chaptersButton": false
},
"lang": {
"controls": {
"play": "{play}",
"pause": "{pause}",
"live": "{live}",
"next": "{next}",
"upNext": "{upNext}",
"playNow": "{playNow}",
"nextVideoCancel": "{nextVideoCancel}",
"replay": "{replay}",
"volume": "{volume}",
"mute": "{mute}",
"unmute": "{unmute}",
"settings": "{settings}",
"theater": "{theater}",
"fullscreen": "{fullscreen}",
"chromecast": "{chromecast}",
"airplay": "{airplay}",
"pictureInPicture": "{pictureInPicture}",
"skipIntro": "{skipIntro}",
"playlistTitle": "{playlistTitle}",
"continueAfterPause": "{continueAfterPause}",
"related": "{related}",
"rewind": "{rewind}",
"forward": "{forward}"
},
"settings": {
"subtitles": "{subtitles}",
"options": "{options}",
"subtitleOptions": {
"reset": "{reset}",
"style": "{style}",
"size": "{size}",
"sizeOptions": {
"small": "{small}",
"medium": "{medium}",
"large": "{large}"
},
"styleOptions": {
"dropShadow": "{dropShadow}",
"dark": "{dark}",
"light": "{light}",
"contrast": "{contrast}"
}
},
"quality": "{quality}",
"autoplay": "{autoplay}",
"playbackRate": "{playbackRate}",
"auto": "{auto}",
"off": "{off}",
"on": "{on}",
"normal": "{normal}",
"share": "{share}",
"autoplayOff": "{autoplayOff}",
"autoplayOn": "{autoplayOn}",
"zoomedToFill": "{zoomedToFill}",
"zoomOut": "{zoomOut}",
"originalZoom": "{originalZoom}",
"captionsOff": "{captionsOff}",
"chromeCastPlayingOn": "{chromeCastPlayingOn}",
"dismiss": "{dismiss}",
"autoGeneratedSubtitles": "{autoGeneratedSubtitles}",
"refresh": "{refresh}",
"audioOnly": "{audioOnly}",
"videoMode": "{videoMode}",
"chapters": "{chapters}"
},
"ads": {
"skip": "{skip}",
"skipIn": "{skipIn}",
"visit": "{visit}",
"info": "{info}",
"simultaneousAds": "{simultaneousAds}",
"adAnnouncement": "{adAnnouncement}"
},
"messages": {
"playbackErrorTitle": "{playbackErrorTitle}",
"playbackErrorDescription": "{playbackErrorDescription}",
"geoBlockedTitle": "{geoBlockedTitle}",
"geoBlockedDescription": "{geoBlockedDescription}",
"streamInterruptedTitle": "{streamInterruptedTitle}",
"streamInterruptedDescription": "{streamInterruptedDescription}",
"streamStartingTitle": "{streamStartingTitle}",
"streamStartingDescription": "{streamStartingDescription}",
"unpublishedTitle": "{unpublishedTitle}",
"unpublishedDescription": "{unpublishedDescription}",
"privateTitle": "{privateTitle}",
"privateDescription": "{privateDescription}",
"paywallRestrictedHover": "{paywallRestrictedHover}",
"paywallRestrictedTitle": "{paywallRestrictedTitle}",
"paywallRestrictedDescription": "{paywallRestrictedDescription}",
"paywallRestrictedButton": "{paywallRestrictedButton}"
}
},
"logo": {
"state": false,
"file": "{logoFile}",
"position": "{logoPosition}",
"defaultOpacity": 1,
"inactiveOpacity": 0.5,
"onClickURL": "{onClickURL}"
},
"skin": {
"controlBar": {
"text": "#FFFFFF",
"background": "#FFFFFF00",
"loaderColor": "#808080",
"controlsBackgroundAlpha": null,
"gradientMidPoint": null,
"spread": null,
"icons": {
"default": "#FFFFFF",
"hover": "#FFFFFF"
},
"timeslider": {
"dragger": "#CC0000",
"progress": "#CC0000",
"rail": "#808080",
"buffer": "#E2E2E2"
},
"volume": {
"dragger": "#FFFFFF",
"progress": "#FFFFFF",
"rail": "#9F9F9F",
"notifier": "#FFFFFF"
},
"timesliderOnAd": {
"dragger": "#FFFFFF",
"progress": "#F5C338",
"rail": "#808080"
}
},
"menus": {
"background": {
"default": "#000000",
"hover": "#000000"
},
"links": {
"default": "#FFFFFF",
"hover": "#CC0000"
},
"autoplay": {
"autoplayOn": "#CC0000",
"autoplayOff": "#A7A7A7"
}
},
"nextVideo": {
"background": "#2E2E2E",
"text": "#FFFFFF",
"timeslider": {
"rail": "#000000",
"progress": "#FFFFFF"
},
"cancel": {
"text": "#000000",
"background": "#FFFFFF"
},
"playNow": {
"text": "#000000",
"background": "#FFFFFF"
},
"icons": {
"play": {
"default": "#FFFFFF",
"hover": "#FFFFFF"
},
"close": "#FFFFFF"
}
},
"playlist": {
"background": "#2E2E2E",
"text": "#FFFFFF",
"card": {
"background": "#000000",
"title": "#FFFFFF",
"duration": {
"text": "#FFFFFF",
"background": "#1A1A1A"
},
"icons": {
"play": {
"default": "#FFFFFF",
"hover": "#FFFFFF"
}
}
},
"icons": {
"arrows": {
"active": "#FFFFFF",
"inactive": "#666666"
},
"close": "#FFFFFF"
}
}
},
"size": {
"sizeType": "{sizeType}",
"aspectRatio": "{aspectRatio}",
"width": 640,
"height": 360
},
"autostartOnLoad": {
"state": false,
"onMobile": false,
"onData": false
},
"autostartOnViewable": {
"state": false,
"onMobile": false,
"onData": false,
"percentageViewable": 0.5
},
"autopauseOnViewable": {
"state": false,
"percentageViewable": 0.5
},
"showRelatedOnPause": {
"state": true,
"onMobile": false,
"from": 0.9
},
"socialMedia": null,
"playbackRates": [
0.25,
0.5,
0.75,
1,
1.25,
1.5,
1.75,
2
],
"prebid": {
"configId": "{prebidConfigId}",
"customHostUrl": "{customHostUrl}",
"accountId": "{accountId}"
},
"autopauseOnCuepoint": {
"state": false,
"timeToPause": 0,
"continueUnmuted": false,
"onDesktop": false,
"onMobile": false,
"svgFile": "{svgFile}"
},
"adAnnouncement": {
"state": true,
"timeBeforeAd": 5
},
"afterMidrollBacktrack": {
"state": true,
"seconds": 3
}
},
"video": {
"videoId": "{videoId}",
"file": "{file}",
"title": "{title}",
"description": "{description}",
"publishDate": "{publishDate}",
"publishEndDate": "{publishEndDate}",
"private": false,
"protected": false,
"passwordProtectedTitle": "{passwordProtectedTitle}",
"passwordProtectedDescription": "{passwordProtectedDescription}",
"chapterState": false,
"chapterPath": "{chapterPath}",
"assetId": "{assetId}",
"hasGeoRestriction": false,
"geoRestrictionLink": "{geoRestrictionLink}",
"hasDrm": false,
"drmLicenseUrl": "{drmLicenseUrl}",
"fpsCertificateUrl": "{fpsCertificateUrl}",
"widevineLicenseUrl": "{widevineLicenseUrl}",
"castContentType": "{castContentType}",
"castVideoSource": "{castVideoSource}",
"thumbnail": "{thumbnail}",
"filmstrip": "{filmstrip}",
"filmstripVtt": "{filmstripVtt}",
"live": false,
"liveType": "{liveType}",
"autoRelated": "{autoRelated}",
"relatedVideos": "{relatedVideos}",
"shareUrl": "{shareUrl}",
"source": "{source}",
"author": "{author}",
"tracks": [
{
"file": "{trackFile}",
"lang": "{lang}",
"label": "{label}"
}
],
"adId": "{adId}",
"startTime": 0,
"maxLiveBackDuration": 0,
"advertising": true,
"showEngagementHeatmap": false,
"ads": {
"type": "{adsType}",
"isVmap": false,
"enableProgrammability": false,
"vmap": "{vmap}",
"skipAllAds": false,
"VPAIDmode": "{vpaidMode}",
"adBreaks": [
{
"adTagUrl": [
"{adTagUrl}"
],
"breakType": "{breakType}",
"breakTimingType": "{breakTimingType}",
"breakTimingValue": 0,
"schedule": {
"liveCount": 0,
"type": "{scheduleType}",
"protectFirst": 0,
"protectLast": 0,
"occurEvery": 30,
"algorithm": null,
"ranges": [
{
"startTime": 0,
"endTime": null,
"count": 1,
"offset": 0,
"breaks": [
50
]
}
]
}
}
],
"bidding": false,
"bidders": [
{
"name": "{bidderName}",
"params": [
{
"paramName": "{paramName}",
"paramType": "{paramType}",
"paramValue": "{paramValue}"
}
]
}
],
"functions": [
{
"key": "{key}",
"isDynamicKey": false,
"isDynamicValue": false,
"value": "{value}",
"order": 0
}
],
"enableDemandManager": false,
"demandManager": {
"prebidUrl": "{prebidUrl}",
"bidderTimeOut": 0,
"serverTimeOut": 0,
"coppaInventory": false,
"enableCache": true,
"adUnits": [
{
"currency": "{currency}",
"networkCode": "{networkCode}",
"adUnitCode": "{adUnitCode}",
"bidOption": "{bidOption}",
"auctionDelay": 0,
"bidders": [
{
"cpmAdjustmentEnabled": false,
"adjustmentValue": null,
"name": "{bidderName}",
"params": []
}
],
"priceGranularities": [
{
"max": 0,
"increment": 0
}
]
}
]
},
"frequency": {
"type": "{frequencyType}",
"value": 0
},
"maxCap": 0,
"initialDelay": {
"type": "{initialDelayType}",
"value": 0
},
"adCycleDelayMs": null,
"adRetryLimit": null,
"adCycleRestartMs": null,
"banner": {
"isEnabled": false,
"adUnitPath": "{adUnitPath}",
"sizes": []
},
"videoOverrides": {
"prerollCount": 0,
"cuePoints": []
}
},
"playlist": {
"state": false,
"playlistId": "{playlistId}",
"playlistVideoIndex": -1,
"algorithm": "{algorithm}",
"shareUrl": "{playlistShareUrl}",
"displayType": "{displayType}",
"fromRecommended": false
},
"skipIntro": {
"state": false,
"skipFrom": null,
"skipTo": null
},
"flags": [],
"tags": [],
"customOverlays": {
"state": false,
"overlays": []
},
"videoLocking": {
"isEnabled": false,
"value": null
},
"videoProperties": [
{
"type": "{propertyType}",
"name": "{propertyName}"
}
]
}
}
If the action is successful, the service sends back an HTTP 200 or 201 response.
The description of the response fields is as follows:
Top-Level Properties
| Field Name | Type | Description |
|---|---|---|
| projectId | string | The unique identifier of the project. |
| config | object | The player configuration object containing all player settings. |
| video | object | The video configuration object containing video metadata, ads, and playback settings. |
config Properties
| Field Name | Type | Description |
|---|---|---|
| configId | string | Unique identifier of the player configuration. |
| biskoId | string | The Bisko identifier associated with the player. |
| recommended | bool | Whether recommended videos are enabled for this player. |
| recommendedId | string | The identifier of the recommended playlist. |
| autoplay | bool | Whether the next video in the playlist autoplays after the current one ends. |
| volume | float | Default volume level of the player (0.0 to 1.0). |
| muted | bool | Whether the player starts muted. |
| loop | bool | Whether the video loops after playback ends. |
| casting | bool | Whether casting functionality (Chromecast/Airplay) is enabled. |
| debug | bool | Whether debug mode is enabled for the player. |
| skipAmount | integer | The number of seconds to skip forward or backward when using skip controls. |
| highlightCurrentVideo | bool | Whether the currently playing video is highlighted in the playlist. |
| onHoverPlay | bool | Whether the video plays when hovering over the player. |
| adsRequireInteraction | bool | Whether ads require user interaction before playing. |
| allowSeekOnLive | bool | Whether seeking is allowed on live video streams. |
| seekLiveAfterPause | bool | Whether the player seeks to the live edge after being paused on a live stream. |
| pauseOtherVideos | bool | Whether other video players on the page are paused when this player starts. |
| focusOnAutostart | bool | Whether the player receives focus when autostart begins. |
| pauseOnRelatedShown | bool | Whether playback pauses when the related videos overlay is shown. |
| readQualities | bool | Whether quality levels are read and displayed from the video source. |
| enableGravityChange | bool | Whether gravity/orientation change is enabled for mobile devices. |
| forceSound | bool | Whether sound is forced on when playback starts. |
| soundSubtitleInversion | bool | Whether subtitles are automatically enabled when the player is muted and disabled when unmuted. |
| chromeCastApplicationId | string | The Chromecast application identifier for casting. |
| showPlayerControlsDuringVideoAdvertisement | bool | Whether player controls are visible during video advertisements. |
| enableHapticFeedbackOnButtonClick | bool | Whether haptic feedback is triggered on button clicks (mobile). |
| enableHapticFeedbackOnPinchToZoom | bool | Whether haptic feedback is triggered on pinch-to-zoom gestures (mobile). |
| usePortraitMode | bool | Whether portrait mode is used for the player. |
| showContentTitle | bool | Whether the content title is displayed on the player. |
| showContentDescription | bool | Whether the content description is displayed on the player. |
| midrollSentenceAlignment | bool | Whether midroll ads are aligned to sentence boundaries in subtitles. |
| useDevicePixelRatio | bool | Whether the device pixel ratio is used when selecting video quality. |
| lightStreamingMode | bool | Whether light streaming mode is enabled for reduced bandwidth usage. |
| showEngagementHeatmap | bool | Whether the engagement heatmap is displayed on the player timeslider. |
| float | object | Floating player configuration. |
| controls | object | Player control buttons configuration. |
| lang | object | Language/localization strings for the player UI. |
| logo | object | Logo overlay configuration. |
| skin | object | Player skin/theme color configuration. |
| size | object | Player size and aspect ratio configuration. |
| autostartOnLoad | object | Autostart on page load configuration. |
| autostartOnViewable | object | Autostart when the player is visible in the viewport. |
| autopauseOnViewable | object | Auto-pause when the player leaves the viewport. |
| showRelatedOnPause | object | Configuration for showing related videos when playback is paused. |
| socialMedia | array[string] | List of enabled social media sharing platforms. |
| playbackRates | array[float] | Available playback speed options. |
| prebid | object | Prebid header bidding configuration. |
| autopauseOnCuepoint | object | Configuration for pausing playback at cue points. |
| adAnnouncement | object | Ad announcement overlay configuration. |
| afterMidrollBacktrack | object | Configuration for backtracking video after a midroll ad ends. |
config.float Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether the floating player is enabled. |
| onMobile | bool | Whether the floating player is enabled on mobile devices. |
| position | string | Position of the floating player (e.g., TOP_RIGHT, TOP_LEFT, BOTTOM_RIGHT, BOTTOM_LEFT). |
| dismissible | bool | Whether the floating player can be dismissed by the user. |
| requiresInteraction | bool | Whether user interaction is required before the player floats. |
| style | object | Style properties for the floating player. |
| style.width | string | Width of the floating player in pixels. |
| style.border | string | Border style of the floating player. |
config.controls Properties
| Field Name | Type | Description |
|---|---|---|
| theaterButton | bool | Whether the theater mode button is displayed. |
| settingsButton | bool | Whether the settings button is displayed. |
| chromecastButton | bool | Whether the Chromecast button is displayed. |
| nextButton | bool | Whether the next video button is displayed. |
| fullscreenButton | bool | Whether the fullscreen button is displayed. |
| airplayButton | bool | Whether the Airplay button is displayed. |
| bigPlayButton | bool | Whether the large centered play button is displayed. |
| pictureInPictureButton | bool | Whether the picture-in-picture button is displayed. |
| volumeButton | bool | Whether the volume button is displayed. |
| shareButton | bool | Whether the share button is displayed. |
| showHelperButton | bool | Whether the helper button is displayed. |
| helperButtonImage | string | URL of the image used for the helper button. |
| showLiveIcon | bool | Whether the live indicator icon is displayed for live streams. |
| delayLiveVideosTime | integer | The delay time in seconds for live video streams. |
| delayLiveVideos | bool | Whether live video delay is enabled. |
| showAutoPlay | bool | Whether the autoplay toggle is displayed in the settings menu. |
| showQualities | bool | Whether the quality selector is displayed in the settings menu. |
| subtitlesButton | bool | Whether the subtitles button is displayed. |
| showCaptions | bool | Whether the captions option is displayed in the settings menu. |
| audioOnlyButton | bool | Whether the audio-only mode button is displayed. |
| rewindButton | bool | Whether the rewind button is displayed. |
| forwardButton | bool | Whether the forward button is displayed. |
| chaptersButton | bool | Whether the chapters button is displayed. |
config.lang.controls Properties
| Field Name | Type | Description |
|---|---|---|
| play | string | Label for the play button. |
| pause | string | Label for the pause button. |
| live | string | Label for the live indicator. |
| next | string | Label for the next button. |
| upNext | string | Label for the up next overlay. |
| playNow | string | Label for the play now button in the next video overlay. |
| nextVideoCancel | string | Label for the cancel button in the next video overlay. |
| replay | string | Label for the replay button. |
| volume | string | Label for the volume control. |
| mute | string | Label for the mute button. |
| unmute | string | Label for the unmute button. |
| settings | string | Label for the settings button. |
| theater | string | Label for the theater mode button. |
| fullscreen | string | Label for the fullscreen button. |
| chromecast | string | Label for the Chromecast button. |
| airplay | string | Label for the Airplay button. |
| pictureInPicture | string | Label for the picture-in-picture button. |
| skipIntro | string | Label for the skip intro button. |
| playlistTitle | string | Label for the playlist title (e.g., "Continue Watching"). |
| continueAfterPause | string | Label for the continue playing button after a pause. |
| related | string | Label for the related videos section. |
| rewind | string | Label for the rewind button. |
| forward | string | Label for the forward button. |
config.lang.settings Properties
| Field Name | Type | Description |
|---|---|---|
| subtitles | string | Label for the subtitles option. |
| options | string | Label for the options menu. |
| subtitleOptions | object | Subtitle customization option labels (contains reset, style, size, sizeOptions, styleOptions). |
| quality | string | Label for the quality option. |
| autoplay | string | Label for the autoplay option. |
| playbackRate | string | Label for the playback rate option. |
| auto | string | Label for the auto quality setting. |
| off | string | Label for the off state. |
| on | string | Label for the on state. |
| normal | string | Label for the normal playback rate. |
| share | string | Label for the share option. |
| autoplayOff | string | Label displayed when autoplay is off. |
| autoplayOn | string | Label displayed when autoplay is on. |
| zoomedToFill | string | Label for the zoom in option. |
| zoomOut | string | Label for the zoom out option. |
| originalZoom | string | Label for the original zoom option. |
| captionsOff | string | Label displayed when captions are off. |
| chromeCastPlayingOn | string | Label displayed when Chromecast is playing. |
| dismiss | string | Label for the dismiss action. |
| autoGeneratedSubtitles | string | Label for auto-generated subtitles. |
| refresh | string | Label for the refresh action. |
| audioOnly | string | Label for the audio-only mode option. |
| videoMode | string | Label for the video mode option. |
| chapters | string | Label for the chapters option. |
config.lang.ads Properties
| Field Name | Type | Description |
|---|---|---|
| skip | string | Label for the skip ad button. |
| skipIn | string | Label for the skip countdown (e.g., "Skip in"). |
| visit | string | Label for the visit advertiser link. |
| info | string | Label for the ad info link. |
| simultaneousAds | string | Label for simultaneous ads indicator. |
| adAnnouncement | string | Text displayed for the ad announcement countdown. |
config.lang.messages Properties
| Field Name | Type | Description |
|---|---|---|
| playbackErrorTitle | string | Title text displayed on playback errors. |
| playbackErrorDescription | string | Description text displayed on playback errors. |
| geoBlockedTitle | string | Title text displayed when the video is geo-blocked. |
| geoBlockedDescription | string | Description text displayed when the video is geo-blocked. |
| streamInterruptedTitle | string | Title text displayed when a live stream is interrupted. |
| streamInterruptedDescription | string | Description text displayed when a live stream is interrupted. |
| streamStartingTitle | string | Title text displayed when a live stream is about to start. |
| streamStartingDescription | string | Description text displayed when a live stream is about to start. |
| unpublishedTitle | string | Title text displayed when the video is unpublished. |
| unpublishedDescription | string | Description text displayed when the video is unpublished. |
| privateTitle | string | Title text displayed when the video is private. |
| privateDescription | string | Description text displayed when the video is private. |
| paywallRestrictedHover | string | Hover text displayed for paywall-restricted content. |
| paywallRestrictedTitle | string | Title text displayed for paywall-restricted content. |
| paywallRestrictedDescription | string | Description text displayed for paywall-restricted content. |
| paywallRestrictedButton | string | Button text displayed for paywall-restricted content. |
config.logo Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether the logo overlay is enabled. |
| file | string | URL of the logo image file. |
| position | string | Position of the logo on the player (e.g., TOP_RIGHT, TOP_LEFT, BOTTOM_RIGHT, BOTTOM_LEFT). |
| defaultOpacity | float | Opacity of the logo when the player controls are active (0.0 to 1.0). |
| inactiveOpacity | float | Opacity of the logo when the player controls are inactive (0.0 to 1.0). |
| onClickURL | string | URL to navigate to when the logo is clicked. |
config.skin Properties
The skin object contains color theming for the player UI. All color values are hex strings (e.g., #FFFFFF).
| Field Name | Type | Description |
|---|---|---|
| controlBar | object | Color settings for the player control bar. |
| controlBar.text | string | Text color on the control bar. |
| controlBar.background | string | Background color of the control bar. |
| controlBar.loaderColor | string | Color of the loading spinner. |
| controlBar.controlsBackgroundAlpha | float | Opacity of the controls background. |
| controlBar.gradientMidPoint | integer | Mid-point value for the control bar gradient. |
| controlBar.spread | string | Spread value for the control bar gradient. |
| controlBar.icons.default | string | Default color of control bar icons. |
| controlBar.icons.hover | string | Hover color of control bar icons. |
| controlBar.timeslider.dragger | string | Color of the timeslider drag handle. |
| controlBar.timeslider.progress | string | Color of the timeslider progress bar. |
| controlBar.timeslider.rail | string | Color of the timeslider rail (background track). |
| controlBar.timeslider.buffer | string | Color of the timeslider buffer indicator. |
| controlBar.volume.dragger | string | Color of the volume slider drag handle. |
| controlBar.volume.progress | string | Color of the volume slider progress bar. |
| controlBar.volume.rail | string | Color of the volume slider rail. |
| controlBar.volume.notifier | string | Color of the volume notifier indicator. |
| controlBar.timesliderOnAd.dragger | string | Color of the timeslider drag handle during ad playback. |
| controlBar.timesliderOnAd.progress | string | Color of the timeslider progress during ad playback. |
| controlBar.timesliderOnAd.rail | string | Color of the timeslider rail during ad playback. |
| menus | object | Color settings for player menus (settings, quality, etc.). |
| menus.background.default | string | Default background color of menus. |
| menus.background.hover | string | Hover background color of menu items. |
| menus.links.default | string | Default text color of menu links. |
| menus.links.hover | string | Hover text color of menu links. |
| menus.autoplay.autoplayOn | string | Color of the autoplay toggle when enabled. |
| menus.autoplay.autoplayOff | string | Color of the autoplay toggle when disabled. |
| nextVideo | object | Color settings for the next video overlay. |
| nextVideo.background | string | Background color of the next video overlay. |
| nextVideo.text | string | Text color of the next video overlay. |
| nextVideo.timeslider.rail | string | Color of the countdown rail in the next video overlay. |
| nextVideo.timeslider.progress | string | Color of the countdown progress in the next video overlay. |
| nextVideo.cancel.text | string | Text color of the cancel button in the next video overlay. |
| nextVideo.cancel.background | string | Background color of the cancel button in the next video overlay. |
| nextVideo.playNow.text | string | Text color of the play now button in the next video overlay. |
| nextVideo.playNow.background | string | Background color of the play now button in the next video overlay. |
| nextVideo.icons.play.default | string | Default color of the play icon in the next video overlay. |
| nextVideo.icons.play.hover | string | Hover color of the play icon in the next video overlay. |
| nextVideo.icons.close | string | Color of the close icon in the next video overlay. |
| playlist | object | Color settings for the playlist panel. |
| playlist.background | string | Background color of the playlist panel. |
| playlist.text | string | Text color of the playlist panel. |
| playlist.card.background | string | Background color of playlist video cards. |
| playlist.card.title | string | Title text color of playlist video cards. |
| playlist.card.duration.text | string | Text color of the duration badge on playlist cards. |
| playlist.card.duration.background | string | Background color of the duration badge on playlist cards. |
| playlist.card.icons.play.default | string | Default color of the play icon on playlist cards. |
| playlist.card.icons.play.hover | string | Hover color of the play icon on playlist cards. |
| playlist.icons.arrows.active | string | Color of active navigation arrows in the playlist. |
| playlist.icons.arrows.inactive | string | Color of inactive navigation arrows in the playlist. |
| playlist.icons.close | string | Color of the close icon in the playlist panel. |
config.size Properties
| Field Name | Type | Description |
|---|---|---|
| sizeType | string | Size type of the player (e.g., RESPONSIVE, FIXED). |
| aspectRatio | string | Aspect ratio of the player (e.g., "16:9", "4:3"). |
| width | integer | Width of the player in pixels (used when sizeType is FIXED). |
| height | integer | Height of the player in pixels (used when sizeType is FIXED). |
config.autostartOnLoad Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether autostart on page load is enabled. |
| onMobile | bool | Whether autostart on page load is enabled on mobile devices. |
| onData | bool | Whether autostart on page load is enabled on mobile data connections. |
config.autostartOnViewable Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether autostart when the player enters the viewport is enabled. |
| onMobile | bool | Whether autostart on viewable is enabled on mobile devices. |
| onData | bool | Whether autostart on viewable is enabled on mobile data connections. |
| percentageViewable | float | The percentage of the player that must be visible to trigger autostart (0.0 to 1.0). |
config.autopauseOnViewable Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether auto-pause when the player leaves the viewport is enabled. |
| percentageViewable | float | The percentage of the player that must be hidden to trigger auto-pause (0.0 to 1.0). |
config.showRelatedOnPause Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether related videos are shown when the video is paused. |
| onMobile | bool | Whether related videos on pause are shown on mobile devices. |
| from | float | The playback progress percentage after which related videos appear on pause (0.0 to 1.0). |
config.prebid Properties
| Field Name | Type | Description |
|---|---|---|
| configId | string | The Prebid configuration identifier. |
| customHostUrl | string | Custom Prebid server host URL. |
| accountId | string | The Prebid account identifier. |
config.autopauseOnCuepoint Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether auto-pause on cue points is enabled. |
| timeToPause | integer | The duration in seconds to pause at cue points. |
| continueUnmuted | bool | Whether the video continues unmuted after the cue point pause. |
| onDesktop | bool | Whether auto-pause on cue points is enabled on desktop. |
| onMobile | bool | Whether auto-pause on cue points is enabled on mobile. |
| svgFile | string | URL of the custom SVG play button displayed during the cue point pause. |
config.adAnnouncement Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether the ad announcement overlay is enabled. |
| timeBeforeAd | integer | Number of seconds before an ad to show the announcement. |
config.afterMidrollBacktrack Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether backtracking after a midroll ad is enabled. |
| seconds | integer | Number of seconds to rewind the video after a midroll ad ends. |
video Properties
| Field Name | Type | Description |
|---|---|---|
| videoId | string | Unique identifier of the video. |
| file | string | URL of the video file (HLS/DASH manifest). |
| title | string | Title of the video. |
| description | string | Description of the video. |
| publishDate | string | Publish date of the video. |
| publishEndDate | string | End date after which the video is unpublished. |
| private | bool | Whether the video is private. |
| protected | bool | Whether the video is password-protected. |
| passwordProtectedTitle | string | Title displayed on the password protection overlay. |
| passwordProtectedDescription | string | Description displayed on the password protection overlay. |
| chapterState | bool | Whether chapters are enabled for the video. |
| chapterPath | string | URL path to the chapters metadata file. |
| assetId | string | The DRM asset/content identifier. |
| hasGeoRestriction | bool | Whether the video has geo-restriction rules applied. |
| geoRestrictionLink | string | Redirect URL for geo-blocked users. |
| hasDrm | bool | Whether the video is DRM-protected. |
| drmLicenseUrl | string | URL for obtaining the DRM license. |
| fpsCertificateUrl | string | URL for the FairPlay Streaming certificate (Apple devices). |
| widevineLicenseUrl | string | URL for the Widevine DRM license. |
| castContentType | string | Content type used when casting (e.g., "application/x-mpegurl"). |
| castVideoSource | string | Video source URL used when casting to external devices. |
| thumbnail | string | URL of the video thumbnail image. |
| filmstrip | string | URL of the filmstrip sprite image used for seek preview. |
| filmstripVtt | string | URL of the VTT file describing filmstrip sprite positions. |
| live | bool | Whether the video is a live stream. |
| liveType | string | Type of the live stream. |
| autoRelated | string | Identifier for automatically generated related videos. |
| relatedVideos | string | Identifier for the manually curated related videos list. |
| shareUrl | string | URL used when sharing the video. |
| source | string | Source or origin of the video content. |
| author | string | Author or creator of the video content. |
| tracks | array[Object] | List of subtitle/caption tracks (each with file, lang, label). |
| adId | string | Identifier of the ad schedule associated with the video. |
| startTime | integer | Start time offset in seconds for video playback. |
| maxLiveBackDuration | integer | Maximum duration in seconds a user can seek back in a live stream. |
| advertising | bool | Whether advertising is enabled for this video. |
| showEngagementHeatmap | bool | Whether the engagement heatmap is shown for this video. |
| ads | object | Advertising configuration for the video. |
| playlist | object | Playlist configuration for the video. |
| skipIntro | object | Skip intro configuration. |
| flags | array[string] | List of flags associated with the video (e.g., "pr_video"). |
| tags | array[string] | List of tags associated with the video. |
| customOverlays | object | Custom overlay configuration for the video. |
| videoLocking | object | Video locking/paywall configuration. |
| videoProperties | array[Object] | List of custom video properties (each with type and name). |
video.ads Properties
| Field Name | Type | Description |
|---|---|---|
| type | string | Type of ad breaks: DYNAMIC or STATIC. |
| isVmap | bool | Whether a VMAP ad tag is used. |
| enableProgrammability | bool | Whether ad programmability is enabled. |
| vmap | string | URL of the VMAP ad tag. |
| skipAllAds | bool | Whether all ads should be skipped for this video. |
| VPAIDmode | string | VPAID compatibility mode. |
| adBreaks | array[Object] | List of ad break configurations. |
| bidding | bool | Whether header bidding is enabled for ads. |
| bidders | array[Object] | List of bidder configurations (each with name and params). |
| functions | array[Object] | List of ad function key-value configurations for ad tag macros. |
| enableDemandManager | bool | Whether the demand manager (Prebid) is enabled. |
| demandManager | object | Demand manager configuration (Prebid URL, timeouts, ad units). |
| frequency | object | Ad frequency configuration (type and value). |
| maxCap | integer | Maximum number of ad impressions per session. |
| initialDelay | object | Initial delay before the first ad (type and value). |
| adCycleDelayMs | integer | Delay in milliseconds between ad cycles. |
| adRetryLimit | integer | Maximum number of ad retry attempts. |
| adCycleRestartMs | integer | Time in milliseconds before the ad cycle restarts. |
| banner | object | Banner ad configuration (isEnabled, adUnitPath, sizes). |
| videoOverrides | object | Video-level ad overrides (prerollCount, cuePoints). |
video.ads.adBreaks[] Properties
| Field Name | Type | Description |
|---|---|---|
| adTagUrl | array[string] | List of VAST ad tag URLs for this break. |
| breakType | string | Type of ad break: preroll, midroll, or postroll. |
| breakTimingType | string | Timing type for static midroll breaks (e.g., "time", "percentage"). |
| breakTimingValue | integer | Timing value for static midroll breaks (seconds or percentage). |
| schedule | object | Dynamic ad break schedule configuration. |
| schedule.liveCount | integer | Number of ad breaks for live streams. |
| schedule.type | string | Schedule type: RECURRING or CUSTOM. |
| schedule.protectFirst | integer | Number of seconds at the start of the video protected from midroll ads. |
| schedule.protectLast | integer | Number of seconds at the end of the video protected from midroll ads. |
| schedule.occurEvery | integer | Interval in seconds between recurring midroll ad breaks. |
| schedule.algorithm | string | Spread algorithm for custom midrolls: PASSIVE, AGGRESSIVE, SIMILAR_DISTANCE, or CUSTOM. |
| schedule.ranges | array[Object] | List of schedule range configurations. |
| schedule.ranges[].startTime | integer | Start time in seconds for this range. |
| schedule.ranges[].endTime | integer | End time in seconds for this range. |
| schedule.ranges[].count | integer | Number of ad breaks within this range. |
| schedule.ranges[].offset | integer | Offset in seconds for ad break placement within the range. |
| schedule.ranges[].breaks | array[float] | Custom break positions (percentages or seconds) within the range. |
video.ads.demandManager Properties
| Field Name | Type | Description |
|---|---|---|
| prebidUrl | string | URL of the Prebid.js library. |
| bidderTimeOut | integer | Timeout in milliseconds for bidder responses. |
| serverTimeOut | integer | Timeout in milliseconds for server-side bidding. |
| coppaInventory | bool | Whether COPPA (Children's Online Privacy Protection Act) compliance is enabled. |
| enableCache | bool | Whether bid caching is enabled. |
| adUnits | array[Object] | List of ad unit configurations for demand manager bidding. |
video.playlist Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether the video is part of a playlist. |
| playlistId | string | Unique identifier of the playlist. |
| playlistVideoIndex | integer | Index of the current video in the playlist (-1 if not applicable). |
| algorithm | string | Algorithm used for playlist ordering. |
| shareUrl | string | URL used when sharing the playlist. |
| displayType | string | Display type of the playlist in the player. |
| fromRecommended | bool | Whether the playlist is generated from recommended videos. |
video.skipIntro Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether skip intro is enabled for the video. |
| skipFrom | integer | Time in seconds when the skip intro button appears. |
| skipTo | integer | Time in seconds to skip to when the skip intro button is clicked. |
video.customOverlays Properties
| Field Name | Type | Description |
|---|---|---|
| state | bool | Whether custom overlays are enabled. |
| overlays | array[Object] | List of custom overlay configurations. |
| overlays[].position | integer | Position of the overlay on the player. |
| overlays[].content | string | HTML content of the overlay. |
| overlays[].from | integer | Time in seconds when the overlay appears. |
| overlays[].to | integer | Time in seconds when the overlay disappears. |
video.videoLocking Properties
| Field Name | Type | Description |
|---|---|---|
| isEnabled | bool | Whether video locking is enabled. |
| value | integer | Time in seconds after which the video is locked and requires action to continue. |
video.videoProperties[] Properties
| Field Name | Type | Description |
|---|---|---|
| type | string | Type of the video property. |
| name | string | Name of the video property. |
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed