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
    size

    Default {"aspectRatio":"16:9","mode":"aspect"}

  • AutostartDeveloperkept unlicensed
    autostart

    Browsers block an autostart with sound, so this needs Muted beside it.

    Default "off"

  • Mute on startDeveloperkept unlicensed
    muted

    Default false

  • Repeat playlistDeveloperkept unlicensed
    repeat

    Default false

  • ControlsDeveloperkept unlicensed
    display.controls

    Default true

  • Media preloadingDeveloperkept unlicensed
    preload

    Default "metadata"

  • LanguageDeveloperkept unlicensed
    language

    Default ""

  • TitleStarter
    display.title

    Default true

  • DescriptionStarter
    display.description

    Default true

  • Frame rate and quality badgesDeveloperkept unlicensed
    display.frameRateLabels

    Default true

  • Motion thumbnailsStarter
    display.motionThumbnails

    Use the item’s motion poster where one exists, rather than the still.

    Default true

  • Floating playerStarter
    floating

    Default {"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
    interaction

    Default {"bezel":true,"doubleClickFullscreen":true,"doubleTapSeek":true,"holdToSpeed":false,"keyboardSheet":true,"lockLandscape":true,"seekBarGrow":true,"tooltipShortcuts":true,"viewerFloat":false,"wheelVolume":true}

  • SharingStarter
    sharing

    Default {"enabled":false,"label":"","networks":["link","email"]}

  • Picture in pictureDeveloper
    pictureInPicture

    Default false

  • Pause if offscreenDeveloper
    pauseWhenHidden

    Default false

  • Playback speedDeveloper
    playbackRates

    Default false

  • Playlist continuationDeveloperkept unlicensed
    playlist

    Default {"autoAdvance":"countdown","countdownSeconds":8,"nextUp":true,"viewerToggle":true}

  • Recommendation engineBusiness
    related.model

    Rank related items from what viewers watched next, what is alike, and what is popular on this property.

    Default "curated"

  • CastingDeveloper
    casting

    Default false

  • Multi-viewGrowth
    multiView

    Default {"enabled":false,"layout":"pip"}

  • 360° videoDeveloper
    vr360

    Draw media marked as 360° as a view the viewer can look around. Off plays it flat.

    Default true

  • Caption appearanceDeveloperkept unlicensed
    captions

    Default {"viewerStyling":true}

  • ChaptersDeveloperkept unlicensed
    chapters

    Default {"enabled":true,"list":true,"snap":true}

  • Low-latency liveDeveloperkept unlicensed
    live

    Plays 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
    transcript

    Default {"enabled":true,"search":true}

  • Audio-only modeDeveloperkept unlicensed
    audioOnly

    A compact audio player, and the lightest rendition of a stream. Media with no picture is drawn this way regardless.

    Default false

  • Sleep timerDeveloperkept unlicensed
    sleepTimer

    Default false

  • Right-click menuDeveloperkept unlicensed
    contextMenu

    Default {"attribution":true,"copyLinkAtTime":true,"debugInfo":true,"loop":true,"shortcuts":true,"stats":false}

  • Attribution removalBusiness
    contextMenu.attribution

    Removes the attribution line from the right-click menu.

    Default true

  • Search metadataStarter
    seoMetadata

    Structured metadata for the item being played, so a page carrying the player is indexable.

    Default false

  • Default bandwidth estimateStarter
    bandwidthEstimate

    Kilobits per second to assume before the engine has measured the connection.

    Default null

  • Ad scheduleBusiness
    adScheduleId

    Default null

  • Offline downloadBusiness
    offline

    A download control, for viewers to keep an item and play it without a network. The key needs offline download too.

    Default false

  • Release channelGrowth
    releaseChannel

    Put this player on its own release channel, ahead of the property’s pin.

    Default null

  • Continue watchingStarter
    plugins.continueWatching.enabled

    Default false

  • Google AnalyticsStarter
    plugins.ga4.enabled

    Default false

  • GA4 measurement IDStarter
    plugins.ga4.measurementId

    Default ""