JW Player Players

https://docs.jwplayer.com/players/
Admin
JW Player Players provides developer documentation and SDKs for integrating powerful video playback,...
Tokens:217,418
Snippets:2,645
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Full Player Configuration for Recommendations

Source: https://docs.jwplayer.com/players/docs/jw8-user-engagement

A comprehensive setup example including display modes, autoplay timers, and localized messaging for the recommendations feature.

```JavaScript
jwplayer("myElement").setup({
  playlist: "https://cdn.jwplayer.com/v2/media/Ly53q8A1?recommendations_playlist_id=n29tZc01",
  nextupoffset: -10,
  related: {
    displayMode: "shelf",
    autoplaytimer: 10,
    oncomplete: "autoplay"
  },
  intl: {
    en: {
      related: {
        autoplaymessage: "__title__ will play in xx seconds",
        heading: "More Amazing Videos"
      }
    },
    fr: {
      related: {
        autoplaymessage: "__title__ commencera dans xx secondes",
        heading: "Plus de vidéos étonnantes"
      }
    }
  }
});
```

--------------------------------

### Configure Player Skin Colors

Source: https://docs.jwplayer.com/players/reference/skin

Example of applying custom colors to various player components using the setup method.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/media/hWF9vG66",
    "skin": {
        "controlbar": {
            "background": "rgba(0,0,0,0)",
            "icons": "rgba(255,255,255,0.8)",
            "iconsActive": "#FFFFFF",
            "text": "#FFFFFF"
        },
        "menus": {
            "background": "#333333",
            "text": "rgba(255,255,255,0.8)",
            "textActive": "#FFFFFF"
        },
        "timeslider": {
            "progress": "#F2F2F2",
            "rail": "rgba(255,255,255,0.3)"
        },
        "tooltips": {
            "background": "#FFFFFF",
            "text": "#000000"
        }
    }
});
```

--------------------------------

### Setup player

Source: https://docs.jwplayer.com/players/docs/android-firetv-set-up-a-player

Apply the configuration to the player instance.

```java
mPlayer.setup(config);
```

--------------------------------

### Register plugins in player setup

Source: https://docs.jwplayer.com/players/docs/jw8-add-a-custom-or-third-party-plugin

Include plugin script URLs and configuration options within the plugins object of the setup method.

```html
<div id="myElement"></div>

<script type="text/JavaScript">
    jwplayer("myElement").setup({ 
        "playlist": "https://cdn.jwplayer.com/v2/media/VjvowSFi",
        "plugins": {       
            "//myexample.com/jwplayer/scripts/sampleScript.js": {
                sampleFunction: () => {
                    console.log('from plugin: hello world');
                },
                name: 'Dan Woon Acorn'
            },
            "//playertest.com/plugins/newsticker.js": {}
        }
    });
</script>
```

--------------------------------

### Define Player Container and Setup

Source: https://docs.jwplayer.com/players/docs/players-troubleshoot-your-player-setup

The player setup must reference the ID of an existing HTML element to avoid initialization errors.

```html
<div id="myElement">Loading the player...</div>
```

```javascript
jwplayer("myElement").setup({
file: 'test.mp4'
});
```

--------------------------------

### Handle setupError event

Source: https://docs.jwplayer.com/players/reference/setup-events

Example JSON structure returned when a player fails to initialize.

```json
{
    "code": 101101,
    "sourceError": null,
    "message": "Sorry, the video player failed to load.",
    "type": "setupError"
}
```

--------------------------------

### Player Setup Configuration Options

Source: https://docs.jwplayer.com/players/reference/setup-options

A reference of properties used within the player setup configuration to manage appearance, dimensions, and playback features.

```APIDOC
## Player Setup Configuration

### Description
These properties are used within the `setup` object of the JW Player to configure the player's appearance, dimensions, and playback behavior.

### Configuration Properties
- **aspectratio** (string) - Maintains proportions when width is a percentage. Must be in `x:y` format.
- **controls** (boolean) - Whether to display video controls. Default: `true`.
- **displaydescription** (boolean) - Configures if the media file description is displayed. Default: `true`.
- **displayHeading** (boolean) - (Outstream only) Controls if the heading above the player is displayed. Default: `false`.
- **displayPlaybackLabel** (boolean) - Enables call-to-action text beneath the play button. Default: `false`.
- **displaytitle** (boolean) - Configures if the media file title is displayed. Default: `true`.
- **height** (number) - Desired height in pixels. Default: `360`.
- **horizontalVolumeSlider** (boolean) - Displays the volume slider horizontally. Default: `false`.
- **livePause** (boolean) - Displays a pause button during live playback. Default: `false`.
- **nextUpDisplay** (boolean) - Configures whether the Next Up modal is displayed.
- **qualityLabels** (array) - Applies custom quality labels to specific bandwidths (kbps). Example: `{"2500":"High","1000":"Medium"}`.
- **renderCaptionsNatively** (boolean) - Determines if browser or player renderer is used for captions (Chrome/Safari).
- **stretching** (string) - Resizes media to fit player dimensions. Options: `uniform`, `exactfit`, `fill`, `none`.
- **width** (number|string) - Desired width in pixels or percentage. Default: `640`.
```

--------------------------------

### adItem Event Object Examples

Source: https://docs.jwplayer.com/players/reference/advertising-events

Example structures of the adItem event object for different ad clients.

```json
{
    "client": "googima",
    "placement": 1,
    "viewable": 1,
    "adposition": "pre",
    "tag": "{ad_tag_url}",
    "adBreakId": "1a2b3c4d5e6f",
    "adPlayId": "1a2b3c4d5e6f",
    "id": "1a2b3c4d5e6f",
    "ima": {
        ...
    },
    "adtitle": "LinearInlineSkippable",
    "adsystem": "GDFP",
    "creativetype": "video/mp4",
    "duration": 10,
    "linear": "linear",
    "description": "LinearInlineSkippable ad",
    "creativeAdId": "",
    "adId": "123456789",
    "universalAdId": [{
        ...
    }],
    "advertiser": "",
    "dealId": "",
    "mediaFile": {
        "file": "{linear_ad_video_file_url}"
    },
    "type": "adItem"
}
```

```json
{
    "client": "vast",
    "placement": 1,
    "adBreakId": "6f5e4d3c2b1a",
    "adPlayId": "6f5e4d3c2b1a",
    "offset": "pre",
    "item": {
        ...
    },
    "type": "adItem"
}
```

--------------------------------

### Configure OpenX Advertising

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Setup for OpenX ad partner integration.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
    "advertising": {
        "bids": {
            ...
            "bidders": [{
                "id": "{unit}",
                "name": "OpenX",
                "delDomain": "{del_domain}"
            }]
        },
        ...
    }
});
```

--------------------------------

### Initialize JW Player with FreeWheel Playlist Configuration

Source: https://docs.jwplayer.com/players/recipes/web-player-specify-ad-content-for-a-specific-playlist-item-freewheel

The initial setup block for the JW Player instance.

```javascript
jwplayer("myElement").setup({
```

--------------------------------

### Configure Azerion Bidder

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Example configuration for the Azerion ad partner.

```JavaScript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
    "advertising": {
        "bids": {
            ...
            "bidders": [{
                "name": "improvedigital",
                "placementId": 1111
            }]
        }
        ...
    }
});
```

--------------------------------

### Configure a fixed-dimensions player instance

Source: https://docs.jwplayer.com/players/docs/jw8-set-the-dimensions-of-a-player

Requires both height and width properties to be defined in the setup object.

```javascript
jwplayer("myElement").setup({ 
  playlist: "https://cdn.jwplayer.com/v2/playlists/xxxxYYYY",
  width: 480,
  height: 270
});
```

--------------------------------

### Configure Emodo Bidder

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Example configuration for the Emodo ad partner.

```JavaScript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
    "advertising": {
        "bids": {
            ...
            "bidders": [{
                "name": "Axonix",
                "supplyId": "1234567"
            }]
        },
        ...
    }
});
```

--------------------------------

### Add startTime to a PlaylistItem

Source: https://docs.jwplayer.com/players/docs/android-firetv-playback

Configure a PlaylistItem with a specific start time and load it into the player configuration.

```java
PlaylistItem playlistItem = new PlaylistItem.Builder()
    .file("https://cdn.jwplayer.com/manifests/{MEDIA_ID}.m3u8")
    .startTime(20)
    .build();

List<PlaylistItem> playlist = new ArrayList<>();
playlist.add(playlistItem);
PlayerConfig config = new PlayerConfig.Builder()
    .playlist(playlist)
    .build();
mPlayer.setup(config);
```

--------------------------------

### Setup playlist with a single URL

Source: https://docs.jwplayer.com/players/reference/playlists

Configures the player to load a playlist from a remote JSON file URL.

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

--------------------------------

### adStarted Event Data Examples

Source: https://docs.jwplayer.com/players/reference/advertising-events

JSON payloads representing the data returned by the adStarted event for different ad clients.

```json
{
    "client": "googima",
    "placement": 1,
    "viewable": 1,
    "adposition": "pre",
    "tag": "//playertest-cdn.longtailvideo.com/vpaid2-jwp-30s.xml?vid_t=Bunny",
    "adBreakId": "179y6cu228me",
    "adPlayId": "179y6cu228me",
    "id": "179y6cu228me",
    "ima": {...},
    "adtitle": "VPAID 2 Linear",
    "adsystem": "Ad System",
    "creativetype": "application/javascript",
    "duration": 30,
    "linear": "linear",
    "description": "VPAID 2 Linear Video Ad",
    "creativeAdId": "",
    "adId": "1234567",
    "universalAdId": [],
    "advertiser": "",
    "dealId": "",
    "mediaFile": {
        "file": "//playertest.longtailvideo.com/vpaid-2-player-test.js"
    },
    "type": "adStarted"
}
```

```json
{
    "client": "vast",
    "placement": 1,
    "adBreakId": "hd7kj31r2jpu",
    "adPlayId": "hd7kj31r2jpu",
    "offset": "pre",
    "id": "1020ed21wj9r",
    "tag": "//playertest-cdn.longtailvideo.com/vast/adpod-first-vpaid.xml",
    "adposition": "pre",
    "sequence": 1,
    "witem": 1,
    "wcount": 1,
    "adsystem": "Ad System",
    "wrapperAdSystem": [
        "Alex_Vast",
        "Alex_Vast"
    ],
    "wrappedTags": [
        "https://playertest.longtailvideo.com/vpaid2-jwp-30s.xml",
        "//playertest.longtailvideo.com/pre.xml",
        "//playertest.longtailvideo.com/mid.xml"
    ],
    "wrapperAdIds": [
        "lr3"
    ],
    "adschedule": {
        "item": 1,
        "tags": [
            "//playertest-cdn.longtailvideo.com/vast/adpod-first-vpaid.xml"
        ],
        "offset": "pre"
    },
    "adtitle": "VPAID 2 Linear",
    "description": "VPAID 2 Linear Video Ad",
    "adId": "1234567",
    "adVerifications": null,
    "advertiser": "",
    "advertiserId": "",
    "creativeId": "",
    "creativeAdId": "",
    "dealId": "",
    "request": {},
    "response": {
        "location": null
    },
    "conditionalAdOptOut": false,
    "vastversion": 3,
    "clickThroughUrl": "http://google.com",
    "mediaFileCompliance": true,
    "mediafile": {
        "file": "//playertest.longtailvideo.com/vpaid-2-player-test.js"
    },
    "viewable": 1,
    "podcount": 3,
    "creativetype": "application/javascript",
    "categories": [],
    "type": "adStarted"
}
```

--------------------------------

### adCompanions Event Payloads

Source: https://docs.jwplayer.com/players/reference/advertising-events

Example JSON payloads for the adCompanions event using IMA and VAST clients.

```json
{
    "client": "googima",
    "placement": 1,
    "viewable": 1,
    "adposition": "pre",
    "tag": "<AD_TAG_URL>",
    "adBreakId": "h3utj61mmce1",
    "adPlayId": "h3utj61mmce1",
    "id": "h3utj61mmce1",
    "ima": {},
    "adtitle": "IAB Vast Samples Skippable",
    "adsystem": "GDFP",
    "creativetype": "video/webm",
    "duration": 51,
    "linear": "linear",
    "description": "IAB Vast Samples Skippable ad",
    "creativeAdId": "",
    "adId": "24283604",
    "universalAdId": [
        {
            "universalAdIdRegistry": "AD-ID",
            "universalAdIdValue": "ABCD1234567"
        }
    ],
    "advertiser": "",
    "dealId": "",
    "mediaFile": {
        "file": "file.webm"
    },
    "companions": [
        {
            "width": 300,
            "height": 250,
            "type": "html",
            "resource": "<a target=\"_blank\" id=\"32948875244\" href=\"<URL>\"><div class=\"overlayContainer\"><img src=\"<IMAGE_URL>\" height=\"250\" width=\"300\"><div class=\"overlayTextAttribution\"></div></div><iframe frameborder=\"0\" src=\"<IFRAME_URL>\" height=\"0\" width=\"0\" id=\"iframe734645111\" style=\"border: 0px; vertical-align: bottom; display: block; height: 0px; width: 0px;\"></iframe></a>"
        },
        {
            "width": 728,
            "height": 90,
            "type": "html",
            "resource": "<a target=\"_blank\" id=\"32948875364\" href=\"<URL>\"><div class=\"overlayContainer\"><img src=\"<IMAGE_URL>\" height=\"90\" width=\"728\"><div class=\"overlayTextAttribution\"></div></div><iframe frameborder=\"0\" src=\"<IFRAME_URL>\" height=\"0\" width=\"0\" id=\"iframe849947827\" style=\"border: 0px; vertical-align: bottom; display: block; height: 0px; width: 0px;\"></iframe></a>"
        }
    ],
    "type": "adCompanions"
}
```

```json
{
    "client": "vast",
    "placement": 1,
    "adBreakId": "1wn8z1bf6tas",
    "adPlayId": "1wn8z1bf6tas",
    "offset": "pre",
    "id": "31d1d4yumxpo",
    "tag": "//playertest-cdn.longtailvideo.com/pre.xml",
    "adposition": "pre",
    "sequence": 1,
    "witem": 1,
    "wcount": 1,
    "adsystem": "Alex_Vast",
    "skipoffset": 5,
    "adschedule": {...},
    "adtitle": "JW Test Preroll",
    "description": "",
    "adId": "232859236",
    "adVerifications": null,
    "advertiser": "",
    "advertiserId": "",
    "creativeId": "",
    "creativeAdId": "",
    "dealId": "",
    "request": {},
    "response": {
        "location": null
    },
    "conditionalAdOptOut": false,
    "vastversion": 2,
    "clickThroughUrl": "//jwplayer.com/",
    "mediaFileCompliance": false,
    "nonComplianceReasons": [
        "video/mp4 has only 1 qualities",
        "video/webm has only 1 qualities"
    ],
    "mediafile": {
        "file": "//content.bitsontherun.com/videos/1EI2jHpo-52qL9xLP.mp4"
    },
    "viewable": 1,
    "creativetype": "video/mp4",
    "companions": [
        {
            "width": 300,
            "height": 250,
            "type": "static",
            "resource": "//s3.amazonaws.com/qa.jwplayer.com/~alex/300x250_companion_1.swf",
            "creativeview": [
                "http://myTrackingURL/firstCompanion"
            ],
            "click": "http://jwplayer.com/"
        },
        {
            "width": 300,
            "height": 250,
            "type": "static",
            "resource": "//s3.amazonaws.com/qa.jwplayer.com/~alex/pre_300X250.jpg",
            "click": "http://jwplayer.com/"
        },
        {
            "width": 728,
            "height": 90,
            "type": "static",
            "resource": "//s3.amazonaws.com/qa.jwplayer.com/~alex/pre_728X90.jpg",
            "click": "http://jwplayer.com/"
        }
    ],
    "type": "adCompanions"
}
```

--------------------------------

### .on('adStarted')

Source: https://docs.jwplayer.com/players/reference/advertising-events

Fires when an ad creative signals to the JWX player that it is starting. This event is supported for VAST, FreeWheel, and IMA ad clients.

```APIDOC
## .on('adStarted')

### Description
Fires when an ad creative signals to the JWX player that it is starting. This event provides a payload containing details about the ad break, the ad server, and the creative being played.

### Parameters
- **adBreakId** (string) - Unique ID for each ad break. All ads in the same break share this ID.
- **adId** (string) - Identity of the ad server that provides the creative.
- **adPlayId** (string) - Unique ID for each individual ad.
- **adposition** (string) - Position of the ad (pre, mid, post).
- **adschedule** (object) - Settings for the ad break.
- **adsystem** (string) - Name of the ad server that returned the ad.
- **adtitle** (string) - Common name for the ad.
- **adVerifications** (object) - Resources and metadata for third-party measurement.
- **advertiser** (string) - Name of the advertiser.
- **advertiserId** (string) - Optional identifier for the advertiser.
- **categories** (array) - List of category codes or labels for the ad content.
- **clickThroughUrl** (string) - URI to the advertiser's site.
- **client** (string) - The ad client being used (freewheel, googima, or vast).
```

--------------------------------

### Configure FreeWheel Advertising

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Example setup for integrating FreeWheel advertising within the JW Player configuration object.

```JavaScript
jwplayer("myElement").setup({
  "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
  "fwassetid": "test_asset",
  "duration": 600,
  "advertising": {
    ...
    "freewheel": {
      "networkid": 12345,
      "adManagerURL": "https://mssl.fwmrm.net/libs/adm/6.24.0/AdManager.js",
      "serverid": "http://demo.v.fwmrm.net/ad/g/1",
      "profileid": "12345:html5_test",
      "sectionid": "test_site_section",
      "streamtype": "live"
    }
  }
});
```

--------------------------------

### .on('adBidRequest')

Source: https://docs.jwplayer.com/players/reference/advertising-events

Fired when header bidding starts requesting for bids. This event provides details about the bid request, including bidders, timeout, and floor price information.

```APIDOC
## .on('adBidRequest')

### Description
Fired when header bidding starts requesting for bids.

### Returns
An object containing the following properties:

- **bidders** (array) - An array of all bidder objects in the current bid request.
- **bidTimeout** (number) - The amount of milliseconds it will wait for the bids to return after user clicks to play.
- **client** (string) - The client currently being used (e.g., 'dai', 'freewheel', 'googima', 'vast').
- **floorPriceCents** (number) - Floor price that the return bids need to beat to play (not returned when using 'dfp' mediation layer).
- **floorPriceCurrency** (string) - The currency of the floor price cents value.
- **mediationLayerAdServer** (string) - The mediation layer (e.g., 'dfp', 'jwp', 'jwpdfp', 'jwpspotx').
- **offset** (string) - The offset of the ad.
- **type** (string) - The type of the event (always 'adBidRequest').
- **viewable** (number) - If the player is viewable or not (0 or 1).

### Bidder Object
Each object in the **bidders** array contains:
- **id** (number) - The publisher ID used for header bidding.
- **name** (string) - The name of the bidder.
```

--------------------------------

### Configure YahooSSP Bidder in JW Player

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Example setup for the YahooSSP bidder within the advertising configuration object.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
    "advertising": {
        "bids": {
            ...
            "bidders": [{
                "name": "YahooSSP",
                "pubid": "{pub_id}",
                "siteId": "{site_id}",
                "id": "{placement_id}"
            }]
        },
        ...
    }
});
```

--------------------------------

### adTime Event Payloads by Client

Source: https://docs.jwplayer.com/players/reference/advertising-events

Examples of the JSON object returned by the adTime event for different ad clients.

```json
{
    "client": "dai",
    "viewable": 1,
    "id": "cz1a5nqne800",
    "adPlayId": "6xszr0hh2v90",
    "adtitle": "External NCA1C1L3 Midroll",
    "adsystem": "GDFP",
    "creativetype": "application/x-mpegURL",
    "linear": "linear",
    "adposition": "mid",
    "position": 0.48821499999999673,
    "duration": 10.01,
    "type": "adTime"
}
```

```json
{
    "client": "freewheel",
    "tag": "placeholder_midroll",
    "freewheel": {
        "ad": {
            "adId": "17302933"
        }
    },
    "adposition": "mid",
    "id": "17302933",
    "linear": "linear",
    "creativetype": "video/mp4",
    "viewable": 1,
    "sequence": 1,
    "podcount": 2,
    "skipoffset": 3,
    "position": 3.393394,
    "duration": 30,
    "type": "adTime"
}
```

```json
{
    "client": "googima",
    "placement": 1,
    "viewable": 1,
    "adposition": "pre",
    "tag": "//pubads.g.doubleclick.net/gampad/ads?sz=640x480...etc",
    "adBreakId": "1n822171mob5",
    "adPlayId": "1n822171mob5",
    "id": "1n822171mob5",
    "ima": {...},
    "adtitle": "External NCA1C1L1 LinearInlineSkippable",
    "adsystem": "GDFP",
    "creativetype": "video/mp4",
    "duration": 10,
    "linear": "linear",
    "description": "External NCA1C1L1 LinearInlineSkippable ad",
    "creativeAdId": "",
    "adId": "697200496",
    "universalAdId": [
        {
            "universalAdIdRegistry": "GDFP",
            "universalAdIdValue": "57860459056"
        }
    ],
    "advertiser": "",
    "dealId": "",
    "mediaFile": {
        "file": ""
    },
    "position": 0,
    "type": "adTime"
}
```

```json
{
    "client": "vast",
    "placement": 1,
    "adBreakId": "mlhd5f15zf6p",
    "adPlayId": "mlhd5f15zf6p",
    "offset": "pre",
    "id": "tfdpe61g5v1f",
    "tag": "//playertest-cdn.longtailvideo.com/pre-60s.xml",
    "adposition": "pre",
    "sequence": 1,
    "witem": 1,
    "wcount": 1,
    "adsystem": "Alex_Vast",
    "skipoffset": 5,
    "adschedule": {
        "item": 1,
        "breakid": "adbreak1",
        "tags": [
            "//playertest-cdn.longtailvideo.com/pre-60s.xml"
        ],
        "offset": "pre"
    },
    "adtitle": "JW Test Preroll",
    "description": "",
    "adId": "232859236",
    "adVerifications": null,
    "advertiser": "",
    "advertiserId": "",
    "creativeId": "",
    "creativeAdId": "",
    "dealId": "",
    "request": {},
    "response": {
        "location": null
    },
    "conditionalAdOptOut": false,
    "vastversion": 2,
    "clickThroughUrl": "//jwplayer.com/",
    "duration": 60,
    "mediaFileCompliance": false,
    "nonComplianceReasons": [
        "video/mp4 has only 2 qualities"
    ],
    "mediafile": {
        "file": "//content.jwplatform.com/videos/zz4Abp0Z-bPwArWA4.mp4"
    },
    "viewable": 1,
    "creativetype": "video/mp4",
    "position": 5.777861,
    "type": "adTime"
}
```

--------------------------------

### adLoaded Event Data Structures

Source: https://docs.jwplayer.com/players/reference/advertising-events

Example JSON payloads returned by the adLoaded event for different ad clients.

```json
{
    "client": "googima",
    "placement": 1,
    "viewable": 1,
    "adposition": "pre",
    "tag": "{ad_tag_url}",
    "adBreakId": "1a3c2b4d5e6f",
    "adPlayId": "1a3c2b4d5e6f",
    "id": "1a3c2b4d5e6f",
    "ima": {
        ...
    },
    "adtitle": "",
    "adsystem": "GDFP",
    "creativetype": "video/mp4",
    "duration": 10,
    "linear": "linear",
    "description": "",
    "creativeAdId": "",
    "adId": "232859236",
    "universalAdId": [],
    "advertiser": "",
    "dealId": "",
    "mediaFile": {
        "file": "{linear_ad_video_file_url}"
    },
    "type": "adLoaded"
}
```

```json
{
    "client": "vast",
    "placement": 1,
    "adBreakId": "1a2b3c4d5e6f",
    "adPlayId": "1a2b3c4d5e6f",
    "offset": "pre",
    "id": "dlsjb0-test",
    "tag": "{ad_tag_url}",
    "adposition": "pre",
    "sequence": 1,
    "witem": 1,
    "wcount": 1,
    "adsystem": "",
    "adschedule": {
        ...
    },
    "item": {
        ...
    },
    "timeLoading": 57,
    "type": "adLoaded"
}
```

--------------------------------

### .on('adPlay')

Source: https://docs.jwplayer.com/players/reference/advertising-events

Fires whenever an ad starts playing or when an ad is unpaused. This event provides detailed metadata about the ad being played, including ad system, position, and client-specific identifiers.

```APIDOC
## .on('adPlay')

### Description
Fires whenever an ad starts playing or when an ad is unpaused.

### Event Properties
- **adBreakId** (string) - Unique ID for each ad break. All ads in the same break share this ID.
- **adId** (string) - Identity of the ad server that provides the creative.
- **adPlayId** (string) - Unique ID for each individual ad.
- **adposition** (string) - Position of the ad (pre, mid, post).
- **adschedule** (object) - Settings for the ad break.
- **adsystem** (string) - Name of the ad server that returned the ad.
- **adtitle** (string) - Common name for the ad.
- **adVerifications** (object) - Resources and metadata for third-party measurement.
- **advertiser** (string) - Name of the advertiser.
- **advertiserId** (string) - Optional identifier for the advertiser.
- **categories** (array) - List of category codes or labels for the ad content.
- **clickThroughUrl** (string) - URI to the advertiser's site.
- **client** (string) - The ad client being used (dai, freewheel, googima, vast).
```

--------------------------------

### Full Outstream Player Implementation

Source: https://docs.jwplayer.com/players/docs/jw8-embed-an-outstream-player

Complete configuration example including ad tags, end-state behavior, custom headings, and floating settings.

```html
<body>
    <div id="jwp-outstream-unit"></div>

    <script>
        jwplayer("jwp-outstream-unit").setup({
            "aspectratio": "16:9",
            "width": "100%",
            "advertising": {
                "client": "vast",
                "outstream": true,
                "tag": "{ad_tag_url}",
                "endstate": "close"
            },
            "displayHeading": true,
            "intl": {
                "en": {
                    "displayHeading": "Awesome Ads"
                }
            },
            "floating": {}
        });
    </script>

</body>
```

```html
<body>
    <div id="jwp-outstream-unit"></div>

    <script>
        jwplayer("jwp-outstream-unit").setup({
            "aspectratio": "16:9",
            "width": "100%",
            "advertising": {
                "client": "googima",
                "outstream": true,
                "tag": "{ad_tag_url}",
                "endstate": "close"
            },
            "displayHeading": true,
            "intl": {
                "en": {
                    "displayHeading": "Awesome Ads"
                }
            },
            "floating": {}
        });
    </script>

</body>
```

--------------------------------

### Configure Xandr Bidder in JW Player

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Example setup for the Xandr (AppNexus) bidder within the advertising configuration object.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
    "advertising": {
        "bids": {
            ...
            "bidders": [{
                "id": "{placementId}",
                "name": "AppNexus",
                "member": "{member}",
                "invCode": "{invCode}",
                "publisherId": "{publisherId}"
            }]
        },
        ...
    }
});
```

--------------------------------

### Handle adBreakIgnored event

Source: https://docs.jwplayer.com/players/reference/advertising-events

Example of the data object returned when an ad break is ignored due to time-between-ads rules.

```json
{
    "id": "adbreak2",
    "tag": "{ad_tag_url}",
    "offset": 6,
    "timeSinceLastAd": 3.256,
    "type": "adBreakIgnored"
}
```

--------------------------------

### jwplayer(div).setup(options)

Source: https://docs.jwplayer.com/players/reference/jwplayerdivsetup-options

Initializes a new JWX player by replacing a specified HTML div element with the player instance using the provided configuration options.

```APIDOC
## jwplayer(div).setup(options)

### Description
Creates a new JWX player on your web page. The player replaces the target <div> element when it appears on the page.

### Parameters
- **div** (string) - Required - The ID of the target <div> element that the web player replaces.
- **options** (JSON) - Required - Configuration settings that control the appearance, behavior, rendering, and loading of the player. At minimum, the `playlist` property must be defined.

### Usage Example
```javascript
<div id="myElement">This text will be replaced with a player.</div>
<script>
    jwplayer("myElement").setup({
        "playlist": "https://cdn.jwplayer.com/v2/media/hWF9vG66"
    });
</script>
```
```

--------------------------------

### jwplayer().setup()

Source: https://docs.jwplayer.com/players/docs/jw8-reference

Initializes a JW Player instance on a specific DOM element with a provided configuration object.

```APIDOC
## jwplayer(id).setup(options)

### Description
Initializes the player on the specified DOM element.

### Parameters
- **id** (string) - Required - The ID of the DOM element where the player will be rendered.
- **options** (object) - Required - Configuration object containing player settings, such as the playlist URL.
```

--------------------------------

### Configure Advertising Rules in JW Player

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Use the advertising.rules object within the player setup to define ad frequency, start conditions, and timing constraints.

```javascript
jwplayer("myElement").setup({
  "playlist": [...],
  "advertising": {
    ...
    "rules": {
      "startOn": 2,
      "frequency": 1,
      "timeBetweenAds": 300,
      "startOnSeek": "pre",
      "deferAds": {}
    }
  }
});
```

--------------------------------

### adError Event JSON Payloads

Source: https://docs.jwplayer.com/players/reference/advertising-events

Examples of the JSON object returned by the adError event for different ad clients.

```json
{
    "id": "-1",
    "message": "Ad Error: Stream initialization failed because\nHTTP status code: 400 with URL: https://pubads.g.doubleclick.net/ondemand/hls/content/1982sa3/vid/ima-test/streams?...",
    "client": "dai",
    "viewable": 1,
    "type": "adError"
}
```

```json
{
    "id": "45759844",
    "client": "freewheel",
    "message": "Ad Error: wrapperUrl=https://playertest.longtailvideo.com/adtags/empty-vast-tags.xml",
    "code": "_e_io",
    "module": "VastTranslator",
    "timeLoading": 935,
    "type": "adError"
}
```

```json
{
    "client": "googima",
    "placement": 1,
    "viewable": 1,
    "tag": "//playertest-cdn.longtailvideo.com/assets/vast/pre-404.xml?vid_t=Bunny",
    "adBreakId": "587c5b15tpsi",
    "adPlayId": "587c5b15tpsi",
    "id": "587c5b15tpsi",
    "adposition": "pre",
    "message": "Ad Error: There was an error playing the video ad.",
    "code": 400,
    "adErrorCode": 20400,
    "sourceError": {
        "stack": "Error: Error: There was an error playing the video ad.\n    at l.getInnerError (https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js:614:757)\n    at adErrorEventObject (https://player-develop-test-jenkins.longtailvideo.com/builds/lastSuccessfulBuild/archive/bin-debug/googima.js:2737:32)\n    at AdsPlayer.getAdErrorEventObject (https://player-develop-test-jenkins.longtailvideo.com/builds/lastSuccessfulBuild/archive/bin-debug/googima.js:3470:14)\n    at AdsPlayer.handleAdError (https://player-develop-test-jenkins.longtailvideo.com/builds/lastSuccessfulBuild/archive/bin-debug/googima.js:3479:35)\n    at AdsPlayer.adError (https://player-develop-test-jenkins.longtailvideo.com/builds/lastSuccessfulBuild/archive/bin-debug/googima.js:3444:12)\n    at xt (https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js:306:200)\n    at l.dispatchEvent (https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js:304:408)\n    at pH (https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js:642:215)\n    at Z.Mc (https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js:637:94)\n    at xt (https://imasdk.googleapis.com/js/sdkloader/ima3_debug.js:306:200)",
        "message": "Error: There was an error playing the video ad."
    },
    "timeLoading": 242,
    "type": "adError"
}
```

```json
{
    "client": "vast",
    "placement": 1,
    "item": {
        "sources": [
            {
                "default": false,
                "type": "mp4",
                "file": "//content.bitsontherun.com/videos/bkaovAYt-52qL9xLP.mp4",
                "label": "0",
                "preload": "metadata"
            }
        ],
        "tracks": [],
        "minDvrWindow": 120,
        "file": "//content.bitsontherun.com/videos/bkaovAYt-52qL9xLP.mp4",
        "preload": "metadata",
        "allSources": [
            {
                "default": false,
                "type": "mp4",
                "file": "//content.bitsontherun.com/videos/bkaovAYt-52qL9xLP.mp4",
                "label": "0",
                "preload": "metadata"
            }
        ],
        "feedData": {},
        "chapters": {
            "defaultLanguage": "en-US",
            "timestamps": []
        }
    },
    "message": "VMAP Schema Error: No AdBreaks in VMAP",
    "code": 1002,
    "adErrorCode": 60005,
    "id": "-1",
    "vmap": "//playertest-cdn.longtailvideo.com/ads/empty-vmap.xml",
    "type": "adError"
}
```

--------------------------------

### Configure Clip URL with jw_start parameter

Source: https://docs.jwplayer.com/players/docs/jw8-google-seo-optimization

Example of appending the jw_start query parameter to a URL within a Clip structured data object to specify a start time in seconds.

```json
"url": "https://www.example.com/example?jw_start=120"
```

--------------------------------

### Configure Outstream Player Basic Setup

Source: https://docs.jwplayer.com/players/docs/jw8-embed-an-outstream-player

Basic configuration for initializing an outstream player unit using either VAST or Google IMA ad clients.

```html
<div id="jwp-outstream-unit"></div>

<script>
    jwplayer("jwp-outstream-unit").setup({
        "aspectratio": "16:9",
        "width": "100%",
        "advertising": {
            "client": "vast",
            "outstream": true
        }
    });
</script>
```

```html
<div id="jwp-outstream-unit"></div>

<script>
    jwplayer("jwp-outstream-unit").setup({
        "aspectratio": "16:9",
        "width": "100%",
        "advertising": {
            "client": "googima",
            "outstream": true
        }
    });
</script>
```

--------------------------------

### Initialize JW Player with setup options

Source: https://docs.jwplayer.com/players/docs/jw8-player-configuration-reference

Configures a player instance with a playlist, autostart behavior, and advertising settings.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/media/hWF9vG66",
    "autostart": "viewable",
    "advertising": {
        "client": "vast",
        "tag": "http://adserver.com/vastTag.xml"
    }
});
```

--------------------------------

### jwplayer().setup() - Legacy Model

Source: https://docs.jwplayer.com/players/reference/float-on-scroll

Configures the floating player using the Legacy model for global, device-agnostic behavior.

```APIDOC
## jwplayer().setup() - Legacy Model

### Description
Configures the player with the Legacy floating model, applying a single global configuration across all devices.

### Parameters
- **floating** (object) - Required - Configuration object for floating behavior.
  - **mode** (string) - Optional - Floating operation mode ('notVisible', 'always', 'never').
  - **dismissible** (boolean) - Optional - Whether the viewer can close the floating player.
  - **showTitle** (boolean) - Optional - Whether to display the video title in the close bar.

### Request Example
```javascript
jwplayer("myElement").setup({
  "playlist": "https://cdn.jwplayer.com/v2/playlists/{playlist_id}",
  "floating": {
    "mode": "notVisible",
    "dismissible": true,
    "showTitle": false
  }
});
```
```

--------------------------------

### .on('setupError')

Source: https://docs.jwplayer.com/players/reference/setup-events

Fires when the player could not be set up.

```APIDOC
## .on('setupError')

### Description
Fires when the player could not be set up.

### Returns
- **code** (number) - Identifier for the error.
- **message** (string) - Error text displayed to the user.
- **sourceError** (object|null) - Lower level error or event, caught by the player, which resulted in this error.
- **type** (string) - Category of error or warning (always 'setupError').

### Response Example
{
    "code": 101101,
    "sourceError": null,
    "message": "Sorry, the video player failed to load.",
    "type": "setupError"
}
```

--------------------------------

### Configure doNotSaveCookies in JW Player setup

Source: https://docs.jwplayer.com/players/reference/do-not-save-cookies

Include the doNotSaveCookies property within the player setup configuration object to enable or disable cookie storage.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/{playlist_id}",
    ...
    "doNotSaveCookies": false
});
```

--------------------------------

### Configure a responsive player instance

Source: https://docs.jwplayer.com/players/docs/jw8-set-the-dimensions-of-a-player

Requires the responsive and aspectratio properties to be set within the setup object.

```javascript
jwplayer("myElement").setup({ 
  playlist: "https://cdn.jwplayer.com/v2/playlists/xxxxYYYY",
  responsive: true,
  width: "50%",
  aspectratio: "16:9"
});
```

--------------------------------

### HTML5 Player Embed Examples

Source: https://docs.jwplayer.com/players/docs/players-create-a-reproduction-page-for-an-html5-player

Examples of different methods to embed the JW Player for reproduction purposes. Ensure non-essential libraries and CSS are removed to isolate the issue.

```html
<html>  
  <head> ... </head>  
  
  <body>  
    
    <script  src="https://content.jwplatform.com/players/UVQWMA4o-aBCdE12G.js"></script>  
    </div>  
</html>
```

```html
<html>  
  <head> ... </head>  
  <body>  
    <iframe  src="https://content.jwplatform.com/players/QI9oRv08-aBCdE12G.html"  width="100%"  height="100%"  frameborder="0"  scrolling="auto"  allowfullscreen  style="position:absolute;"></iframe> 
  </body>  
</html>
```

```html
<html> 
  <head>  
    <script  src="https://cdn.jwplayer.com/libraries/aBCdE12G.js"></script>  
  </head>  
  <body>  
    <!-- Here is the <div> for the player -->  <div  id="myElement"></div> 
    <script  type="text/JavaScript"> jwplayer("myElement").setup({  "playlist":  "https://cdn.jwplayer.com/v2/media/xxxxYYYY"  }); 
    </script>  
  </body>  
</html>
```

--------------------------------

### Configure SpotX Bidder Parameters

Source: https://docs.jwplayer.com/players/reference/advertising-config-ref

Example of setting price floors and custom parameters for the SpotX ad partner.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/playlists/a12bc3D4",
    "advertising": {
        "bids": {
            ...
            "bidders": [{
                "name": "SpotX",
                "id": "85395",
                "optionalParams": {
                    "price_floor": 5.30,
                    "custom": {
                        "name": "{custom_param_name_goes_here}",
                        "value": "{custom_param_value_goes_here}"
                    }
                }
            }]
        },
        ...
    }
});
```
Tokens:
Raw