Skip to main content

Full Configuration


vpPlayer("vp-config").setup({
projectId: 'string',
biskoId: 'string',
video: {
videoId: 'string',
assetId: 'string',
fpsCertificateUrl: 'string',
widevineLicenseUrl: 'string',
related: 'string',
file: 'string',
title: 'string',
duration: 0,
description: 'string',
live: false,
liveType: 'string',
thumbnail: 'string',
filmstrip: 'string',
tracks: [],
startTime: 0,
skipIntro: {
state: false,
skipFrom: 0,
skipTo: 0,
},
flags: [
{
id: 0,
name: 'string',
},
],
playlist: {
state: false,
playlistId: 'string',
playlistVideoIndex: -1,
highlightCurrentVideo: false,
algorithm: 'string',
title: 'string',
videos: [],
},
advertising: false,
adId: 'string',
ads: {
skipAd: {
state: true,
skipFrom: 5,
},
vmap: 'string',
VPAIDmode: 'string',
enableProgrammability: false,
functions: [
{
isDynamicKey: false,
isDynamicValue: false,
key: 'string',
order: 1,
value: 'string',
},
],
bidding: false,
afterMidrollBacktrack: {
state: false,
seconds: 0,
},
adBreaks: [
{
adTagUrl: [],
breakType: 'midroll',
breakTimingType: 'time',
breakTimingValue: 10,
},
],
bidders: [
{
name: 'bidderName',
params: {
propertyId: '123123',
placementId: '123123',
},
},
],
},
},
config: {
configId: 'string',
size: {
sizeType: 'RESPONSIVE',
aspectRatio: '16:9',
width: 800,
height: 450,
},
adAnnouncement: {
state: false,
timeBeforeAd: 5,
},
autoplay: false,
autostartOnLoad: {
state: false,
onMobile: false,
onData: false,
},
autostartOnViewable: {
state: false,
onMobile: false,
onData: false,
percentageViewable: 0.5,
},
autopauseOnViewable: {
state: false,
percentageViewable: 0.5,
},
pauseOtherVideos: false,
focusOnAutostart: false,
showRelatedOnPause: {
state: true,
onMobile: false,
from: 0.9,
},
playbackRates: [],
volume: 1,
muted: false,
loop: false,
casting: true,
debug: false,
skipAmount: 5,
adsRequireInteraction: false,
float: {
state: false,
onMobile: false,
position: 'BOTTOM_RIGHT',
dismissible: true,
requiresInteraction: false,
toVideoThreshold: 0.35,
toFloatThreshold: 0.2,
style: {
width: 272,
border: 'string',
},
},
controls: {
theaterButton: false,
settingsButton: true,
chromecastButton: false,
nextButton: true,
fullscreenButton: true,
airplayButton: true,
bigPlayButton: true,
pictureInPictureButton: true,
relatedButton: true,
volumeButton: true,
shareButton: true,
},
logo: {
state: false,
file: 'string',
position: 'TOP_RIGHT',
defaultOpacity: 1,
inactiveOpacity: 0.5,
onClickURL: 'string',
},
socialMedia: [],
lang: {
locale: 'en',
controls: {
play: 'Play',
pause: 'Pause',
next: 'Next',
replay: 'Replay',
volume: 'Volume',
mute: 'Mute',
unmute: 'Unmute',
settings: 'Settings',
theater: 'Theater',
fullscreen: 'Full Screen',
chromecast: 'Chromecast',
airplay: 'Airplay',
pictureInPicture: 'Picture-in-Picture',
related: 'Related',
skipIntro: 'Skip intro',
skipAd: 'Skip Ad',
adAnnouncement: 'Ad in {} seconds',
playlistTitle: 'Continue Watching',
upNext: 'Up next...',
live: 'LIVE',
continueAfterPause: '',
},
settings: {
quality: 'Quality',
subtitles: 'Subtitles',
autoplay: 'Autoplay',
playbackRate: 'Speed',
auto: 'Auto',
off: 'Off',
normal: 'Normal',
share: 'Share Video',
},
ads: {
ad: 'Ad',
skip: 'Skip',
skipIn: 'Skip in: ',
visit: 'Visit Us',
info: 'Read more',
simultaneousAds: 'Playing {current} out of {total} ads',
},
},
skin: {
controlBar: {
background: 'string',
text: '#FFFFFF',
icons: {
default: '#FFFFFF',
hover: '#FFFFFF',
},
timeslider: {
progress: '#CC0000',
rail: '#808080',
buffer: '#E2E2E2',
dragger: '#CC0000',
},
volume: {
dragger: '#FFFFFF',
progress: '#FFFFFF',
rail: '#9F9F9F',
notifier: '#FFFFFF',
},
timesliderOnAd: {
progress: '#46c4eb',
rail: '#808080',
buffer: null,
dragger: '#FFFFFF',
},
},
menus: {
background: {
default: 'rgba(0, 0, 0, 0.7)',
hover: 'rgba(0, 0, 0, 0.7)',
},
links: {
default: '#FFFFFF',
hover: '#CC0000',
},
autoplay: {
autoplayOn: '#CC0000',
autoplayOff: '#A7A7A7',
},
},
nextVideo: {
background: 'rgba(46, 46, 46, 0.7)',
text: '#FFFFFF',
timeslider: {
rail: 'rgba(0, 0, 0, 0.3)',
progress: '#FFFFFF',
},
icons: {
play: {
default: '#FFFFFF',
hover: '#FFFFFF',
},
close: '#FFFFFF',
},
},
playlist: {
background: 'rgba(46, 46, 46, 0.7)',
text: '#FFFFFF',
icons: {
arrows: {
active: '#FFFFFF',
inactive: '#666666',
},
close: '#FFFFFF',
},
card: {
background: 'rgba(0, 0, 0, 0.35)',
title: '#FFFFFF',
duration: {
text: '#FFFFFF',
background: 'rgba(26, 26, 26, 0.5)',
},
icons: {
play: {
default: '#FFFFFF',
hover: '#FFFFFF',
},
},
},
},
},
},
});