Configuration
Every option a player accepts. You set them on a player in the dashboard, and the snippet names the player with data-player; a page with no player uses the defaults below.
Editions, lowest first: Developer, Starter, Growth, Business, Enterprise. An option can be changed from the edition shown beside it and every one above; below that, it stays at its default. Without a licence, only options marked kept unlicensed apply, and the rest return to their defaults.
- Player sizeDeveloperkept unlicensed
sizeDefault
{"aspectRatio":"16:9","mode":"aspect"} - AutostartDeveloperkept unlicensed
autostartBrowsers block an autostart with sound, so this needs Muted beside it.
Default
"off" - Mute on startDeveloperkept unlicensed
mutedDefault
false - Repeat playlistDeveloperkept unlicensed
repeatDefault
false - ControlsDeveloperkept unlicensed
display.controlsDefault
true - Media preloadingDeveloperkept unlicensed
preloadDefault
"metadata" - LanguageDeveloperkept unlicensed
languageDefault
"" - TitleStarter
display.titleDefault
true - DescriptionStarter
display.descriptionDefault
true - Frame rate and quality badgesDeveloperkept unlicensed
display.frameRateLabelsDefault
true - Motion thumbnailsStarter
display.motionThumbnailsUse the item’s motion poster where one exists, rather than the still.
Default
true - Floating playerStarter
floatingDefault
{"desktop":{"closeButton":"always","enabled":false,"position":"bottom-right"},"phone":{"closeButton":"always","enabled":false,"position":"bottom-right"},"tablet":{"closeButton":"always","enabled":false,"position":"bottom-right"}} - InteractionDeveloperkept unlicensed
interactionDefault
{"bezel":true,"doubleClickFullscreen":true,"doubleTapSeek":true,"holdToSpeed":false,"keyboardSheet":true,"lockLandscape":true,"seekBarGrow":true,"tooltipShortcuts":true,"viewerFloat":false,"wheelVolume":true} - SharingStarter
sharingDefault
{"enabled":false,"label":"","networks":["link","email"]} - Picture in pictureDeveloper
pictureInPictureDefault
false - Pause if offscreenDeveloper
pauseWhenHiddenDefault
false - Playback speedDeveloper
playbackRatesDefault
false - Playlist continuationDeveloperkept unlicensed
playlistDefault
{"autoAdvance":"countdown","countdownSeconds":8,"nextUp":true,"viewerToggle":true} - CastingDeveloper
castingDefault
false - Multi-viewGrowth
multiViewDefault
{"enabled":false,"layout":"pip"} - 360° videoDeveloper
vr360Draw media marked as 360° as a view the viewer can look around. Off plays it flat.
Default
true - Caption appearanceDeveloperkept unlicensed
captionsDefault
{"viewerStyling":true} - ChaptersDeveloperkept unlicensed
chaptersDefault
{"enabled":true,"list":true,"snap":true} - Low-latency liveDeveloperkept unlicensed
livePlays a live stream a few seconds behind the broadcast, fetching partial segments where the stream has them.
Default
{"catchUpRate":1.1,"lowLatency":false,"targetLatency":3} - TranscriptDeveloperkept unlicensed
transcriptDefault
{"enabled":true,"search":true} - Audio-only modeDeveloperkept unlicensed
audioOnlyA compact audio player, and the lightest rendition of a stream. Media with no picture is drawn this way regardless.
Default
false - Sleep timerDeveloperkept unlicensed
sleepTimerDefault
false - Right-click menuDeveloperkept unlicensed
contextMenuDefault
{"attribution":true,"copyLinkAtTime":true,"debugInfo":true,"loop":true,"shortcuts":true,"stats":false} - Attribution removalBusiness
contextMenu.attributionRemoves the attribution line from the right-click menu.
Default
true - Search metadataStarter
seoMetadataStructured metadata for the item being played, so a page carrying the player is indexable.
Default
false - Default bandwidth estimateStarter
bandwidthEstimateKilobits per second to assume before the engine has measured the connection.
Default
null - Ad scheduleBusiness
adScheduleIdDefault
null - Offline downloadBusiness
offlineA download control, for viewers to keep an item and play it without a network. The key needs offline download too.
Default
false - Release channelGrowth
releaseChannelPut this player on its own release channel, ahead of the property’s pin.
Default
null - Continue watchingStarter
plugins.continueWatching.enabledDefault
false - Google AnalyticsStarter
plugins.ga4.enabledDefault
false - GA4 measurement IDStarter
plugins.ga4.measurementIdDefault
""