This page has been updated for JW Player 8. Click here to go to the JW7 Configuration Reference.

JW Player Configuration Reference

This article contains all configuration options JW Player supports.

Certain JW Player features may require a specific license. Please contact our team if your license does not support the features or configuration options you need.
Table Of Contents
Setup Options Playlists Skin
Captions RTMP Logo
Sharing Google Analytics Related
Advertising DRM Localization

Introduction

JW Player contains a number of configurable options. Some options, like width or mute, are top level, while other more advanced options may be nested, such as the ones used for skin customizations and advertising.

Here is an example setup that contains both setup options and specific advertising options:

jwplayer("myElement").setup({
  "file": "https://example.com/myVideo.mp4",
  "height": 360,
  "width": 640,
  "autostart": "viewable",
  "advertising": {
        "client": "vast",
        "tag": "http://adserver.com/vastTag.xml"
    }
});


Setup Options

These are the options for configuring the layout and playback behavior of a player. Each is placed directly into the setup of the player.

The following properties are related to media that is loaded into the player.

If only a single playlist item is used, this information can either be configured directly inside of setup. If you are planning on using multiple media items, these can also be used inside of a playlist array.


Media

Setting Type Description Default
file String (Required) URL to a single video file, audio file, or live stream to play. Can also be configured inside of a sources array -
image String URL to a poster image to display before playback starts. -
title String The title of your video or audio item -
description String A description of your video or audio item -
mediaid String Unique identifier of this item. Used by advertising, analytics and discovery services -
type String Defining the video file type is required when using a media file url that does not have an extension. Possible values: aac, mp4, f4v, m4v, mov, mp3, mpeg, ogv, ogg, oga, vorbis, webm, f4a, m3u8, m3u, hls. -
YouTube and RTMP media formats are no longer supported.8.0+


Behavior

Setting Type Description Default
mute Boolean Configures if the player should be muted during playback false
autostart String Whether the player will attempt to begin playback automatically when a page is loaded. Set to 'viewable' to have player autostart if 50% is viewable. false
nextupoffset Number Configures when the Next Up card displays during playback. A positive value is an offset from the start of the video. A negative number is an offset from the end of the video -10
repeat Boolean Configures if the player should loop content after a playlist completes false
abouttext String Custom text to display in the right-click menu -
aboutlink String Custom URL to link to when clicking the right-click menu "https://www.jwplayer.com/learn-more"
playbackRateControls Boolean Whether to display a settings menu to adjust playback speed. If true, the pre-defined options available in the menu are 0.5x, 1x, 1.25x, 1.5x, and 2x. An array can be passed to customize the menu options using playbackRates. Note: This feature is not currently supported in Android with HLS streams. false
playbackRates 8.0+ Array of Numbers Custom playback rate options to display in the settings menu. [0.25, 0.75, 1, 1.25]
defaultBandwidthEstimate 8.3+ Number Sets an initial bandwidth estimate, in bits per second, for all viewers. All values, including negative ones, below the minimum of 1 will be rounded up. To set the highest quality as an initial estimate, reference the highest bitrate from your manifest. -


Appearance

Setting Type Description Default
controls Boolean Whether to display the video controls (control bar and display icons) true
localization Object Changes text for the player in certain locations -
aspectratio String Maintains proportions when width is a percentage. Will not be used if the player is a static size.
Must be entered in ratio "x:y" format.
-
height Number The desired height of your video player (In pixels). Can be omitted when aspectratio is configured 360
width Number or String The desired height of your video player (In pixels or percentage) 640
displaytitle Boolean Configures if the title of a media file should be displayed true
displaydescription Boolean Configures if the description title of a media file should be displayed true
stretching String Resize images and video to fit player dimensions. See graphic below for examples
"uniform" — Fits JW Player dimensions while maintaining aspect ratio
"exactfit": Will fit JW Player dimensions without maintaining aspect ratio
"fill"— Will zoom and crop video to fill dimensions, maintaining aspect ratio
"none" — Displays the actual size of the video file. (Black borders)
"uniform"
nextUpDisplay Boolean Configures whether the Next Up modal is displayed -
qualityLabels Array By default, the JW Player will set video quality levels using information from the manifest files. Use this configuration option to apply a custom quality label to a desired bandwidth in kbps, works for HLS and DASH. For example: "qualityLabels":{"2500":"High","1000":"Medium"} -
timeSliderAbove, which configures whether the timeslider dynamically appears above the control bar, has been deprecated. 8.0+

Stretching Examples


Rendering and Loading

Setting Type Description Default
base String Configures an alternate base path for skins and providers "/"
preload String Tells the player if content should be loaded prior to playback. Useful for faster playback speed or if certain metadata should be loaded prior to playback:
"none" — Player will explicitly not preload content. (Recommended if you are concerned about excess content usage.)
"metadata" — Loads the manifest and buffers a maximum of one segment of media for HLS and Dash streams.
"auto" — Loads the manifest and buffers approximately 30 seconds worth of media segments.
"metadata"
flashplayer String Specifies an alternate directory of jwplayer.flash.swf "/"
hlsjsdefault Boolean Makes HLSjs the default provider when supported. Disable to use the browser's default provider. true
liveTimeout 8.1.9+ Number Configure how a stalled live manifest is handled. Accepts a positive number in seconds, but values between 1-10 are ignored. Set to 0 to configure a stream to never time out. The player will continue requesting manifests until it times out. If a live manifest does not update after being requested for longer than liveTimeout, the stream will end with an error event. If you want a stream to end immediately, include an end tag in the manifest. This configuration option only handles stalled manifests, not issues with segment loading. A chunk that results in a 404, for example, will still error out. 30
primary, which set the default player rendering mode, has been deprecated.8.0+ Flash is no longer supported in JW Player except to play HLS streams in IE11 on Windows 7.

The default preload configuration has been updated to "metadata", and the metadata and auto settings have been redefined.8.0+

Casting

Enable casting from directly within the video. This configuration option places either a Chromecast or Airplay icon in the controlbar, depending on the browser and device used. If casting is unavailable, the icon will be hidden. To enable casting, simply include an empty cast block in your setup.

jwplayer("myElement").setup({
  "file": "https://example.com/myVideo.mp4",
  "height": "auto"
  "width": "100%",
  "cast": {}
});

If you have a custom receiver, specify the ID as a string with cast.appid.


Playlists

The playlist is a powerful feature of JW Player, used to play multiple video or audio files.

A playlist can be either a string, referring to the URL of an RSS feed or JSON file, or an array of media objects.

Configuring Playlist as a String

jwplayer("myElement").setup({
  "playlist": "http://example.com/myPlaylist.json"
});


Configuring Playlist as an Array

jwplayer("myElement").setup({
    "playlist": [{
        "file": "/assets/sintel.mp4",
        "image": "/assets/sintel.jpg",
        "title": "Sintel Trailer",
        "mediaid": "ddra573"
    },{
        "file": "/assets/bigbuckbunny.mp4",
        "image": "/assets/bigbuckbunny.jpg",
        "title": "Big Buck Bunny Trailer",
        "mediaid": "ddrx3v2"
    }]
});
Setting Type Description
playlist[index].file String (Required) If no file is specified in your setup or sources, this is a required configuration option
playlist[index].withCredentials Boolean If true, "withCredentials" will be used to request a media file rather than CORS
playlist[index].title String Title of the item. This is displayed inside of the player prior to playback, as well as in the visual playlist. This can be hidden with the displaytitle option
playlist[index].description String Short description of the item. It is displayed below the title. This can be hidden with the displaydescription option.
playlist[index].image String Poster image URL. Displayed before and after playback.
playlist[index].mediaid String Unique identifier of this item. Used by advertising, analytics and discovery services
playlist[index].recommendations String URL to a feed that contains related items for a particular playlist item
playlist[index].minDvrWindow Number HLS-only In seconds, the minimum amount of content in an M3U8 required to trigger DVR mode. Set to 0 to always display DVR mode.(Defaults to 120)
playlist[index].sources[] Array Used for quality toggling and alternate sources
playlist[index].tracks[] Array Include captions, chapters, and thumbnails for media
playlist[index].adschedule Object Schedule advertising for a specific media file

In addition to standard media information, ("title", "description", "mediaid") it is also possible to insert additional metadata, using custom properties. This information must be entered inside of a playlist, and cannot be set directly inside of a setup block.


playlist[index].sources[]

Sources are inserted into playlist objects and are lists of files. Sources serve a dual purpose, depending on the files used:

  • Use different file types: Alternate "fallback" media sources
  • Use the same file type: Toggle quality with static video files

Alternate Media Sources

If using different file types, sources prioritizes which file to play only in the case when a provider (HTML5, HLS, or DASH) fails to load. If there is an error with a stream, the player will not failover to the next provider. In the example below, the player will attempt to play myVideo.m3u8 as a first choice.

In the event that a browser cannot play an m3u8, the player is intelligent enough to choose myVideo.mp4 instead. In the event that an mp4 cannot be played, the player will attempt the webm format before producing an error.

jwplayer("myElement").setup({
  "playlist": [{
    "title":"One Playlist Item With Multiple Sources",
    "description":"Three Sources - One Playlist Item",
    "image": "myImage.png",
    "mediaid": "ddrx3v2",
    "sources": [{
      "file": "myVideo.m3u8"
    },{
      "file": "myVideo.mp4"
    },{
      "file": "myVideo.webm"
    }]
  }]
});


Sources with DRM

When using DRM, we highly suggest placing the drm block inside of the appropriate media source. This ensures the correct media and DRM pair gets chosen for the appropriate browser. For example:

  "sources": [{
      "file": "myFairplayStream.m3u8",
      "drm": {
        "fairplay": {
          "certificateUrl": "http://myfairplay.com/fairplay/cert",
          "processSpcUrl": "http://myfairplay.com/fairplay/ckc"
        }
      }
    },{
      "file": "myWidevineStream.mpd",
      "drm": {
        "widevine": {
          "url": "http://mywidevineurl.com/drm"
          }
      }
    },{
      "file": "myPlayreadyStream.mpd",
      "drm": {
        "playready": {
          "url": "http://myplayreadyurl.com/drm"
          }
      },{
      "file": "myClearkeyStream.mpd",
      "drm": {
        "clearkey": {
          "key": "1234clear5678key",
          "keyId": "fefde00d-efde-adbf-eff1-baadf01dd11d"
          }
      }
    }]

See our drm section for more information.


Manifest and Segment Requests with Custom Headers

You can add custom headers to media XHR requests by using the onXhrOpen callback. This gets executed after XMLHTTPRequest.open() and before XMLHTTPRequest.send() for HLS manifest, key and segment requests made by the player. This is not available in Safari browsers where HLS is played natively.

jwplayer().setup({
    playlist: [{
        sources: [{
            file: 'video.m3u8',
            onXhrOpen: function(xhr, url) {
                xhr.setRequestHeader('customHeader', 'customHeaderValue');
            }
        }]
    }]
})
For HLSjs playback only.


Quality Settings for Video Files

In the event that a streaming technology like HLS or DASH cannot be used, listing video files of different qualities will enable a quality selection settings menu in the player. Compared to other streaming methods, it has the following drawbacks:

  • No automatic switching, based on bandwidth or download speed
  • Changing qualities may cause playback stuttering
  • Pseudostreaming may need to be configured in cases where Flash is used
jwplayer("myElement").setup({
  "playlist": [{
    "title":"One Playlist Item With Multiple Qualities",
    "description":"Two Qualities - One Playlist Item",
    "sources": [{
      "file": "myVideo-720p.mp4",
      "label": "HD"
    },{
    "file": "myVideo-480p.mp4",
    "label": "SD"
    }]
  }]
});
Config Type Description
playlist[index].sources[].file String URL to the video file, audio file, YouTube video or live stream of this playlist item source.
playlist[index].sources[].label String Label of the media source, displayed in the manual quality selection menu. Set this if you have more than 2 qualities of your video.
playlist[index].sources[].type String Forces a media type. Only required when a file extension is missing or not recognized (Using .php or certain tokens, for example
playlist[index].sources[].default Boolean Set this to true for the media source you want to play on startup. If this isn't set for any source, the first one is used
playlist[index].sources[].drm Object An object containing DRM information for a particular source


playlist[index].tracks[]

Tracks can be attached to media for three possible reasons: captions, thumbnails, or chapters. Thumbnail and chapter files must be in WEBVTT format. Captions accept WEBVTT, SRT, and DFXP format, though JW Player strongly suggests using WEBVTT if possible.

Config Type Description Default
playlist[index].tracks[].file String URL to the captions, chapters or thumbnails text track file. See Adding Closed Captions for an example setup. -
playlist[index].tracks[].kind String The kind of text track.
"captions": Captions that display during video playback
"chapters": Places markers on the video er, displaying different sections
"thumbnails": A list of thumbnails that appear when the mouse cursor hovers on the timeslider
"captions"
playlist[index].tracks[].label String Label of the text track. Is only used in setups with multiple captions, where the label is displayed in the CC selection menu. index
playlist[index].tracks[].default Boolean Only for captions. Set this to true if you want a captions track to display by default -

When using the playlist to load an RSS feed, these options are set in the feed. See the Media Formats Reference for an mapping of all playlist options to RSS format.


Video ad insertion requires a JW Player Enterprise license. Please contact our team to upgrade your account.

playlist[index].adschedule

The playlist[index].adschedule block is used for scheduling ad breaks throughout specific playlist items. Each adbreak should be given a unique name, and needs to be nested inside of an adschedule block.

Config Type Information
playlist[index].adschedule.adbreak.offset String or Number Specifies when the included tag should play during content. Can be pre for a preroll, post for a postroll, or a % or number(In seconds), for a midroll
playlist[index].adschedule.adbreak.tag String This is used to set the ad tag for each adbreak within the ad schedule of a playlist item.
jwplayer("myElement").setup({
  "playlist": [{
  "title":"One Media Item",
  "description":"Only One media item in a playlist!",
  "file": "myFile.mp4",
  "mediaid": "ddrx3v2",
  "image": "myImage.png",
    "adschedule": {
      "myPreroll": {
      "offset": "pre",
      "tag": "myAdTag.xml"
      },
    "myMidroll": {
      "offset": 10,
      "tag": "myMidroll.xml"
      }
    }
  }]
});

See our Advertising section for more articles and examples

360 videos

360/VR videos require a playlist block in order to work, even for single items. They will not work at the global level using "file." Playlists can contain a mix of 360 and non-360 items.

Playlist configuration options described above can be used with spherical videos. Below are 360-specific options.

Config Type Description Default
playlist.stereomode String (Required) This field is required for each 360 item in a playlist. If it is undefined, the video will not render in 360 mode. Supported values are "monoscopic", "stereoscopicTopBottom", and "stereoscopicLeftRight". -


Skin

JW8 comes with 11 new skin configuration options out of the box. With such granular control over brand identity, it’s easier than ever to customize the player.

Color Customization

Color can be specified as a hex value, RGBA color value, or color name.8.0+

Config Type Description Default
skin.controlbar.text String The color of any plain text in the control bar, such as the time. "#FFFFFF"
skin.controlbar.icons String The default, inactive color of all icons in the control bar. This option also controls the color of the play, pause, and replay icons in the inactive and complete states. "rgba(255,255,255,0.8)"
skin.controlbar.iconsActive String The color of hovered or selected icons in the control bar. "#FFFFFF"
skin.controlbar.background String TThe background color of the control bar and the volume slider. The default background is transparent. "rgba(0,0,0,0)"
skin.timeslider.progress String The color of the bar in the time slider filled in from the beginning of the video through the current position. The buffer region of the control bar is 50% of the opacity of this color. The color of the volume slider is also controlled by this option. "#F2F2F2"
skin.timeslider.rail String The color of the base of the timeslider, known as the rail. "rgba(255,255,255,0.3)"
skin.menus.text String The color of inactive, default text in menus and the Next Up overlay. "rgba(255,255,255,0.8)"
skin.menus.textActive String The color of hovered or selected text in menus. This option also controls the text color in the Discover overlay and the hover state text color in the Next Up overlay. "#FFFFFF"
skin.menus.background String The background color of menus and the Next Up overlay. "#333333"
skin.tooltips.text String The text color of tooltips. "#000000"
skin.tooltips.background String The background color of tooltips. "#FFFFFF"


Backward Compatability

JW8 continues to support the three color customization options from 7.x, skin.active, skin.inactive, skin.background, though the colors may map slightly differently in the new major version.

The table below shows how the three JW7 customization options map to the new JW8 options. You can use both JW7 and JW8 options in an 8 player, with the more specific JW8 configurations overriding JW7 ones when both apply to the same element. Note that there’s no JW7 mapping to the new skin.timeslider.rail option.

New JW8 Config skin.active skin.inactive skin.background
skin.controlbar.iconsActive X
skin.timeslider.progress X
skin.menus.textActive X
skin.controlbar.text X
skin.controlbar.icons X
skin.menus.text X
skin.tooltips.text X
skin.tooltips.background X
skin.controlbar.background X
skin.menus.background X
skin.timeslider.rail does not map


Custom Skins

For more information regarding custom skins, see: Creating a Skin for JW Player.

Config Type Description Default
skin.url String If using an external CSS file to style your player, this must be specified here. -
skin.name String The name of your custom skin to use for styling the player. If you are specifying skin.url, you must specify skin.name, which must match the class name in your CSS file. -
The nine skins available in JW7 have been deprecated.8.0+


Captions

This options block configures the styling of closed captions in the player for desktop browsers. On iOS/Android, a system settings menu provides exactly the same settings, as these are mandated by the FCC.

Config Type Description Default
renderCaptionsNatively Boolean If true, captions render using the browser's renderer. If false, the player's renderer will be used in all browsers, except for Safari. Note: This configuration is not contained within the captions block. false  8.0.1+
captions.color String Hex color of the captions text "#ffffff"
captions.fontSize Number Size of the captions text (Will not affect text size when rendering captions via browser) 15
captions.fontFamily String Font Family of the captions text "sans"
captions.fontOpacity Number Alpha percentage of the captions text 100
captions.backgroundColor String Hex color of the caption characters background "#000000"
captions.backgroundOpacity Number Alpha percentage of the caption characters background 75
captions.edgeStyle String Method by which the captions characters are separated from their background "none"
captions.windowColor String Hex color of the background of the entire captions area "#000000"
captions.windowOpacity Number Alpha percentage of the background of the entire captions area 0
When setting caption styles, color must be specified as a hex value.

See Styling Captions for FCC Compliance for more information.


RTMP

The RTMP format was deprecated in JW8. For 7.x players, see the JW7 RTMP Configuration Reference documentation.


This options block configures a clickable watermark that is overlayed on the video.

Config Type Description Default
logo.file String The URL of an external JPG, PNG or GIF image to be used as watermark (e.g. /assets/logo.png). We recommend using 24 bit PNG images with transparency -
logo.hide Boolean When this option is set to true, the logo will automatically show and hide along with the other player controls false
logo.link String The URL to visit when the watermark image is clicked. Clicking a logo will have no affect unless this is configured -
logo.margin Number The distance, in pixels, of the logo from the edges of the display 8
logo.position String This sets the corner in which to display the watermark. "control-bar" adds the logo as the leftmost icon in the right grouping of buttons in the control bar.8.0+
"top-left"
"top-right"
"bottom-left"
"bottom-right"
"control-bar"
"top-right"

See Branding Your Player for more information.

We highly recommend using low-resolution images for logos in the player, as Internet Explorer may not resize an image, especially if it is high-resolution.


Sharing

This options block controls a settings submenu with social sharing options: copy embed code, copy video link and share video to social networks.

Setting an empty "sharing":{} options block will enable the social sharing menu and icon in the control bar. Without the nested config options, it will show the page URL link with default sharing sites, but no embed code.

Config Type Description Default
sharing.link String URL to display in the video link field URL of the current page
sharing.code String Embed code to display in the embed code field. If no code is set, the field is not shown -
sharing.heading String Short, instructive text to display at the top of the sharing screen "Share Video"
sharing.sites Array Allows for the customization of social icons ["facebook","twitter","email"]


Available Built-In Social Networks

Social Network Configuration Value Social Network Configuration Value
Facebook "facebook" Tumblr "tumblr"
Twitter "twitter" Google Plus "googleplus"
Pinterest "interest" Reddit "reddit"
Email "email" LinkedIn "linkedin"

Example

jwplayer("myElement").setup({
  "file": "http://example.com/myVideo.mp4",
  "sharing": {
    "sites": ["reddit","facebook","twitter"]
  }
});

See our Social Sharing support article for more information.


Google Analytics (ga)

This options block configures the built-in integration with Google Analytics.

Config Type Description Default
ga.label String Send another playlist property, like "title" or "mediaid", as your event label in Google Analytics "file"

Google's separate JavaScript library and config needs to be included in your page's head in order to send events with JW Player. Setting an empty "ga":{} options block will enable basic Google Analytics integration. No additional nested config options are required.

See Connecting Google Analytics for more information.


This options block controls an overlay with related videos.

Config Type Description Default
related.file String (Required) Location of an RSS or JSON file containing a feed of related videos -
related.displayMode 8.1.9+ String Configure the recommendations user interface. Does not apply to manual playlists.
"overlay": Adds a "more videos" icon to the control bar. When clicked, an overlay takes over the player, pausing playback.
"shelf" (default): Adds a horizontal bar of thumbnails above the control bar, which allows viewers to browse recommended videos throughout the playback experience. The shelf can be collapsed into a "More Videos" button, which appears above the control bar. Due to size constraints, small players fall back to "overlay" mode.
"shelf"
related.oncomplete String The behavior of our related videos overlay when a single video or playlist is completed
"hide": Replay button and related icon will appear
"show": Display the related overlay
"autoplay": automatically play the next video in your related feed after 10 seconds. Automatically sets onclick behavior to "play"
"show"
related.onclick String The behavior when a related video is selected.
"play": Plays the next video within the current player.
"link": Redirects the page to the url specified in the related item's link field.
"play"
related.autoplaytimer Number The number of seconds to wait before playing the next related video in your content list. Set to 0 to have your next related content to play immediately 10
related.autoplaymessage String A custom message that appears during autoplay.
xx will be replaced by the countdown timer
__title__ will be replaced by the next title in the related feed.
"__title__ will play in xx seconds"

See Display Related Videos for more information.


Advertising

Video ad insertion requires a JW Player Enterprise license. Please contact our team to upgrade your account.

This options block configures the video advertising capabilities of JW Player. If no schedule is specified, the ad will play as a preroll by default.

Option Type Description Client Default
advertising.client String (Required for Advertising)
Chooses the ad client that will be used to display advertisements:
"vast": Use the JW Player VAST client
"googima": Use the Google IMA SDK - Required for certain ad tags
"freewheel": Use the Freewheel client
All -
advertising.tag String The URL of the VAST tag to display, or custom string of the Freewheel tag to display All -
advertising.admessage String Text that displays during ad playback All "The ad will end in xx seconds"
advertising.skipoffset Number If not present in the VAST file, adds a skip offset to static VAST ads VAST, Freewheel -
advertising.cuetext String Specify the text that appears when a user mouses over a scheduled advertisement All "Advertisement"
advertising.skipmessage String This is used to provide a customized countdown message VAST, Freewheel "Skip ad in xx"
advertising.skiptext String This sets the text of the Skip button after the countdown is over VAST, Freewheel "Skip"
advertising.vpaidmode String (IMA VPAID-only)
"disabled": VPAID ads will not play and an error will be returned if VPAID is requested
"enabled": VPAID is enabled using a cross domain iFrame. The VPAID ad cannot access the site. VPAID ads that depend on friendly iFrame access may not play
"insecure": The VPAID ad will load in a friendly iFrame. This allows the ad access to the site via javascript
Not supported in Freewheel
IMA "insecure"
advertising.schedule String or Object Load an ad schedule from an external VMAP XML or JSON block. advertising.tag is ignored if this option is set All -
advertising.companiondiv Object Gives information to the player related to which div(s) to populate with companion ads
Not supported in Freewheel
VAST, IMA -
advertising.autoplayadsmuted Boolean For inline players that start muted when viewed on mobile devices, allows ads to play muted All -
advertising.vpaidcontrols Boolean For forcing controls to show for VPAID ads. If the VPAID creative has built-in controls, showing the controls may be redundant VAST, IMA -
advertising.forceNonLinearFullSlot Boolean For forcing nonlinear ads to be fullsot ads rather than overlays IMA -
advertising.setLocale String Valid two-letter language code for localization of skip-button language IMA -
advertising.creativeTimeout Number In milliseconds, the maximum amount of time between the VAST XML being returned and the adStart event before timing out VAST 15000
advertising.requestTimeout Number For VAST, the maximum amount of time, in milliseconds, between the ad request and a returned VAST file before timing out.

For IMA and Freewheel, the maximum amount of time, in milliseconds, between the ad request and the ad impression being fired.
VAST, IMA, Freewheel 5000 (VAST), 10000 (IMA), 15000 (FW)
advertising.vastLoadTimeout Number In milliseconds, the maximum amount of time between the ad request and a returned VAST file before timing out IMA 10000
advertising.loadVideoTimeout Number In milliseconds, the maximum amount of time between the VAST XML being returned and the adstart event before timing out IMA, Freewheel 15000
advertising.maxRedirects Number The maximum number of redirects the player should follow before timing out IMA 4
advertising.conditionaladoptout Boolean (VPAID-only) Used to tell the player to not play ads with the conditionalAd attribute inside of the VAST response VAST false
advertising.podmessage String Text that displays during playback of an ad pod. Use __AD_POD_CURRENT__ to denote the currently playing item in the pod and __AD_POD_LENGTH__ for the total number of ads in the pod. VAST "Ad xx of yy."
advertising.bids Object Enable video player bidding with the given settings and bidders. IMA -
advertising.rules Object Enable ad rules with the given settings and bidders. VAST, IMA -
advertising.freewheel.adManagerURL String Freewheel-supplied Ad Manager URL Freewheel -
advertising.preloadAds Boolean Enable pre-loading of midrolls and postrolls in click-to-play and autostart: 'viewable' scenarios VAST, IMA "false"


advertising.schedule

Use this option to load an entire advertising schedule to JW Player, containing multiple ad breaks. The option can be a URL to a VMAP schedule or an inline JSON block with ads. This schedule will then be applied to each playlist item. For scheduling ads for individual playlist items, see scheduling ads for playlist items.

Ad Schedules with VMAP Files

If you are planning on using a VMAP file, simply link to a VMAP .xml file within the advertising block.

jwplayer("myElement").setup({
  "file": "http://example.com/myVideo.mp4",
  "advertising": {
    "client": "vast",
    "schedule": "myvmap.xml"
  }
});

The VMAP schedule will then be applied to each playlist item. See our article about VMAP schedules for more information.

Embedded Ad Schedules with JSON

In order to use a JSON-formatted schedule, you'll need at least one ad break configured inside of an advertising block. Each ad break is required to have a unique name, and should include a tag and offset.

Option Type Description Default
advertising.schedule.adbreak.tag String The ad tag that is called during the configured ad break -
advertising.schedule.adbreak.offset String or Number When to play the configured ad tag
"pre": Ad plays as a preroll
"post": Ad plays as a postroll
"xx%": Ad plays after xx% of the content
number: Ad plays after the specified number of seconds
"pre"
advertising.schedule.adbreak.type String This should be set to nonlinear if you want to force the player to render a nonlinear ad in the ad response. -
jwplayer("myElement").setup({
  "file": "http://example.com/myVideo.mp4",
  "advertising": {
    "client": "vast",
    "schedule": {
      "adbreak-preroll":{
        "tag": "myPreroll.xml",
        "offset": "pre"
      },
      "adbreak-midroll":{
        "tag": "myMidroll.xml",
        "offset": "50%"
      }
    }
  }
});
Option Type Description Default
advertising.schedule.adbreak.custParams Object Allows for passing custom parameters to an ad break, which then pass through to the URL requested from the ad server -
"advertising": {
        "client": "googima",
        "adscheduleid": "12345",
        "schedule": {
            "preroll": {
                "custParams": {
                    "testkey1": "testval1",
                    "testkey2": "testval2"
                },
                "tag": "myPreroll.xml",
                "offset": "pre"
            }
        }
    }


advertising.bids

Use this option to try video player bidding with supported bidders. Click here for more information on how to get started.

Video Player Bidding with JW

In order for JW Player to work as mediation layer, the following options need to be set in settings, and bidders needs to have at least one supported bidder.

Option Type Description Default
advertising.bids.settings.mediationLayerAdServer String The mediation layer, which is the decision-maker in what ad to run. See the table below for the available choices for the mediation layer. jwp
advertising.bids.settings.floorPriceCents Number The price in cents (CPM) that a bid has to beat in order to win -
advertising.bids.settings.floorPriceCurrency String The currency of the floorPriceCents. Currently only usd is supported with "jwp" as the mediation layer usd
advertising.bids.settings.bidTimeout String Timeout for bid response after the user clicks to play, in milliseconds 2000
advertising.bids.bidders[index].name String The name of the bidder (ex. "SpotX") -
advertising.bids.bidders[index].id String The id of the publisher -


Available Mediation Layers

Option Supported Clients Description
jwp VAST, Google IMA The default mediation layer. Compares bid prices against the floor price with the higher bid winning. If the floor wins, the fallback ad tag is used.
jwpspotx VAST, Google IMA Similar to the "jwp" mediation layer but ignores the floor price, allowing SpotX to easily be used as the primary ad server by always winning the bid.
dfp Google IMA Uses DFP as your mediation layer by adding key value pairs to the DFP tag to match up with the bidder's line items within DFP
jwpdfp Google IMA Combines the "jwp" and "dfp" mediation layers in that order. If the floor price isn't beaten, the key value pairs are added to the DFP tag.


jwplayer("myElement").setup({
  "file": "http://example.com/myVideo.mp4",
  "advertising": {
    "client": "googima",
    "tag": "mytag.xml",
    "bids": {
      "settings": {
        "mediationLayerAdServer": "jwp",
        "floorPriceCents": 10,
        "floorPriceCurrency": "usd",
        "bidTimeout": 1000
      },
      "bidders": [
        {
          "name": "BIDDER",
          "id": 12345
        }
      ]
    }
  }
});

Header Bidding with DFP

When DFP is set as the mediation layer, "floorPriceCents" and "floorPriceCurrency" do not need to be set.

jwplayer("myElement").setup({
  "file": "http://example.com/myVideo.mp4",
  "advertising": {
    "client": "googima",
    "tag": "mytag.xml",
    "bids": {
      "settings": {
        "mediationLayerAdServer": "dfp",
        "bidTimeout": 1000
      },
      "bidders": [
        {
          "name": "BIDDER",
          "id": 12345
        }
      ]
    }
  }
});


advertising.rules

Use this option to control how frequently ads play back. See our Ad Rules Reference support article for more information.

Option Type Description Default
startOn Number The first playlist item that will allow ad playback, index starting at 1. 1
frequency Number Play ads only on every X playlist item. i.e. frequency 3 means only play on ads on every third playlist item. Use 0 to only play ads on the first playlist item. 1
startOnSeek String If automatically seeking on a visitor’s return visit, this option specifies whether or not a preroll ad should be served. If this rule is not set, both the preroll and most recent midroll will play. -
timeBetweenAds Number After displaying an ad in a schedule with multiple ad breaks, require a minimum of X seconds to pass before playing the next scheduled ad. 0
jwplayer("myElement").setup({
  "playlist": [
    {
      "file": "http://example.com/myVideo.mp4"
    },
    {
      "file": "http://example.com/myVideo2.mp4"
    }
  ],
  "advertising": {
    "client": "vast",
    "schedule": {
      "adBreak1": {
        "tag": "mytag.xml",
        "offset": 10
      },
      "adBreak2": {
        "tag": "mytag2.xml",
        "offset": 20
      }
    }
    "rules": {
      "startOn": 2,
      "frequency": 1,
      "timeBetweenAds": 300,
      "startOnSeek": "pre"
    }
  }
});


advertising.companiondiv

This is a configuration block object with 3 properties: id, width and height. Set these to have JW Player load a companion ad from your VAST/IMA tag into a div on your page. See Companion Ads for more info.

Option Type Description
advertising.companiondiv.height Number The targeted desired height of a companion ad that exists in a VAST ad
advertising.companiondiv.width Number The targeted desired width of a companion ad that exists in a VAST ad
advertising.companiondiv.id String The ID of the div to replace with a companion ad

For an overview of JW Player's advertising capabilities, see its dedicated Video Ads section.


DRM

Video content protection requires a JW Player Enterprise license. Please contact our team to upgrade your account.

Configuration options related to DRM for MPEG DASH (Playready, Widevine, Clearkey) and HLS streams (Fairplay).

JW Player includes the ability to add DRM to a specific playlist source. Using this method will allow your browser to choose the correct DRM method when multiple DRM types are configured. We highly suggest updating any configurations to use this new method.

HTTPS is required for all DRM-protected content.

For more information regarding DRM, and for examples, please view our support article.

drm.playready

Playready DRM is specific to Internet Explorer 11 and Edge on Windows 8.1 or higher operating systems.

Option Type Description Default
drm.playready.url String (Required) The URL of the PlayReady license server -
drm.playready.headers Array Specifies the custom http headers to send to your playready license server. See headers for more information -
drm.playready.licenseRequestFilter Function Expects a function which takes a single request argument. License request filters intercept license requests before 'licenseRequestHeaders' are added. -
drm.playready.licenseResponseFilter Function Expects a function which takes a single response argument. License response filters intercept license responses before updating the session with the license key. -


drm.widevine

Widevine DRM is specific to Google Chrome on non-iOS devices. Widevine will also function on Firefox browsers for desktop systems.

Option Type Description Default
drm.widevine.url String (Required) The URL of the WideVine license server -
drm.widevine.serverCertificateUrl String The URL of the WideVine service certificate -
drm.widevine.headers Array Specifies the custom http headers to send to your widevine license server requests. See headers for more information -
drm.widevine.licenseRequestFilter Function Expects a function which takes a single request argument. License request filters intercept license requests before 'licenseRequestHeaders' are added. -
drm.widevine.licenseResponseFilter Function Expects a function which takes a single response argument. License response filters intercept license responses before updating the session with the license key. -


drm.[widevine/playready].headers

Adding customized HTTP header data to license requests is possible with the "headers" configuration. This replaces the static "customData" configuration option in both widevine and playready scenarios. It is also possible to add multiple custom http headers by including multiple objects in the "headers" array.

DRM can be configured in the following way:

"drm": {
  "playready": {
  "url": "mydrmserver.com"
  "headers": [{
    "name": "customData",
    "value": "hereismycustomdatastring"
    }]
  }
}

In previous versions, adding "customData" would look like the following:

"drm": {
  "playready": {
  "url": "mydrmserver.com"
  "customData": "hereismycustomdatastring"
  }
}
Option Type Description
headers.name String The name of the http header that will be included
headers.value String The value of the http header that will be included


drm.fairplay

JW Player includes configuration options for custom Fairplay integrations. For more information and examples regarding custom Fairplay DRM integrations, please view our support article.

Option Type Description
drm.fairplay.certificateUrl String (Required) The path to the certificate which is part of the session data used to initialize the keySession.certificateUrl
drm.fairplay.processSpcUrl String or Function (Required) The path to the license server (server playback context) which provides the ckc. Expects a direct url to the server. If the url needs to be constructed dynamically, a custom function can be passed to this configuration option which returns the url
drm.fairplay.extractContentId Function Expects a function that receives the initData uri (converted to a string) from the needkey event, and returns the contentId which is part of the session data used to initialize the keySession
drm.fairplay.licenseRequestHeaders Array Expects an Array of Objects containing header “name” and “value” properties to be included in the request to the license server
drm.fairplay.licenseResponseType String Specifies the data type returned by the XHR request to the license server. The default value is 'arraybuffer'. Other options include 'blob', 'json', and 'text'. This option impacts how “licenseRequestMessage” will be processed
drm.fairplay.licenseRequestMessage Function Expects a function that receives the license key message and returns the message to be sent to the license server. With the default “licenseResponseType” of ArrayBuffer this function passes through keymessage event message property without any changes
drm.fairplay.extractKey Function Expects a function that receives the ckc returned by the license server and returns the key used to update the active key session. If the key can only be extracted asynchronously (for example reading bytes from a ‘blob’ response), this function can return a promise
drm.fairplay.licenseRequestFilter Function Expects a function which takes a single request argument. License request filters intercept license requests before 'licenseRequestHeaders' are added.
drm.fairplay.licenseResponseFilter Function Expects a function which takes a single response argument. License response filters intercept license responses before updating the session with the license key.


drm.clearkey

A basic form of DRM that lists a decryption key inside of your player configuration. This is the least secure form of DRM, though it is the simplest to implement across browsers. There are no additional server resources required to decrypt content with this method. Clearkey is supported in both Chrome and Firefox browsers.

Option Type Description
drm.clearkey.key String (Required) The key required to decrypt DRM content
drm.clearkey.keyId String (Required) The key ID specified in the mpd's default_KID value


Localization

Using the localization block in a player configuration allows you to configure text used in the player's user interface for titles, descriptions, ARIA labels and tool tips. The available options are below.

Option Type Description Default
localization.airplay String Title of the tooltip for the Airplay icon in the control bar "Airplay"
localization.audioTracks String Title of the tooltip for the audio track menu "Audio tracks"
localization.buffer String Title of the buffer state "Loading"
localization.cast String Title of the tooltip for the Chromecast icon in the control bar "Chromecast"
localization.cc String Title of the tooltip for the captions menu "Closed captions"
localization.close String Close text and title of close icons "Close"
localization.copied 8.1.8+ String Text when a link is copied to the clipboard in the sharing menu "Copied"
localization.errors.badConnection 8.4.0+ String Shown for errors caused by the viewer's connection. "This video cannot be played because of a problem with your internet connection"
localization.errors.cantLoadPlayer 8.4.0+ String Shown when there's a failed attempt to load the player or one of its components "Sorry, the video player failed to load"
localization.errors.cantPlayInBrowser 8.4.0+ String Displayed for browser-specific errors "The video cannot be played in this browser"
localization.errors.cantPlayVideo 8.4.0+ String Shown when there is no playable media "This video file cannot be played"
localization.errors.errorCode 8.4.0+ String Text shown before the error code "Error Code"
localization.errors.liveStreamDown 8.4.0+ String Shown when a live stream has ended or is no longer available "The live stream is either down or has ended"
localization.errors.protectedContent 8.4.0+ String Shown when there is a problem providing access to protected content "There was a problem providing access to protected content"
localization.errors.technicalError 8.4.0+ String Shown for technical errors where the exact cause is unknown "This video cannot be played because of a technical error"
localization.fullscreen String Title of tooltip to enter fullscreen mode "Fullscreen"
localization.hd String Title of the tooltip for the quality menu "Quality"
localization.liveBroadcast String Override for the state of a live stream "Live"
localization.loadingAd String Override for the text shown when an ad is loading "Loading ad"
localization.more String Override for uses of a prompt to load addition items "More"
localization.next String Title of the right arrow in paginated overlays "Next"
localization.nextUp String Override for the "Next Up" prompt "Next Up"
localization.nextUpClose String Title of the tooltip to close the "Next Up" prompt "Next Up Close"
localization.pause String Tooltip for the pause button "Pause"
localization.play String Tooltip for the play button "Play"
localization.playback String Override for the play button in an idle state "Start playback"
localization.playbackRates String Title of the tooltip for the playback rate controls menu "Playback rates"
localization.player String Override for the player application "Video Player"
localization.playlist String Title of the icon tooltip and overlay heading in Playlist mode "Playlist"
localization.prev String Title of the left arrow in paginated overlays "Previous"
localization.related String Title of recommended video screen headings and tooltips "More Videos"
localization.replay String Title of the tooltip for the replay button shown on completion "Replay"
localization.rewind String Title of tooltip for the rewind button in the control bar "Rewind 10s"
localization.stop String Title of tooltip for the stop button in the control bar for live streams "Stop"
localization.videoInfo String Label for the video info overlay accessible via the right click menu "About this video"
localization.volume String Tooltip for the volume controls "Volume"