Platform DocsPlayers DocsRelease Notes
System StatusSubmit a CaseDashboard LoginContact Sales

<img src="https://img.shields.io/badge/%20-ENTERPRISE-%23B10031" style="float:left"/>   <img src="https://img.shields.io/badge/Player-3.14.0%2B-blue" style="float:left"><br />

Outstream players are ads-only video players designed to run inside of text article pages without requiring any video content.

<br />



If you have limited or no developer resources, you also [embed an outstream player through an ad tag or a simple code snippet](🔗).

<br /> <hr />

## Requirements

ItemDescription
**Ad tag**(VAST, IMA) You must have an ad tag from your ad server, creative agency, or advertiser.
**JWP licensing**You must have Outstream enabled for your account.
**JW Player library 8.14.0+**Outstream player functionality is fully supported only from JWP 8.14.0.

<br /> <hr />

## Configure an outstream player

Use the following steps to configure an outstream player.

  1. In the `<head>` of the page, [add the player library](🔗) to the page.

  2. Within the `<body>` of your page, copy and paste one of the following code snippets.


<br />
  1. Add the URL of the ad tag to `tag` in the advertising object. 
  2. (Optional) To configure the player to gradually close and disappear after the ad plays, add `"endstate": "close"` to the `advertising` object.
    
    By default, a [gray background](🔗) without controls remains. You can customize this background with additional elements like an image, logo, or replay button.
  3. (Optional) Outside of the `advertising` object, add `"displayHeading": "true"` to display an _Advertisement_ heading.
  4. (Optional) By default, enabling `displayHeading` will use the word “Advertisement.” This can be changed or variations can be added for different languages.
    
    Learn more about [automated player localization](🔗). Outside of the `advertising` object, add `intl.{lang}.displayHeading` to customize the `displayHeading` text.
<br />
### Full code samples

<br />
<hr />
## Additional settings
After implementing the basic Outstream setup, you can customize your implementation with any of these additional properties.
### (Global)
For explanations of each property listed below, see: [Setup Options](🔗) or the reference links.
  • **advertising** _See: [advertising](🔗)_
   • **aspectratio**
   • **autoPause**  _See: [autopause](🔗)_
   • **controls**
   • **displayHeading**
   • **floating**  _See: [floating](🔗)_
   • **height**
   • **intl**
   • **preloadAds**
   • **repeat**
   • **width**
<br />
### advertising
For explanations of each property listed below, see: [advertising](🔗).
PropertyVASTIMA
**bids**<br />_See: [advertising.bids](🔗)_**✓****✓**
**companiondiv**<br />_See: [advertising.companiondiv](🔗)_**✓****✓**
**conditionaladoptout****✓**
**creativeTimeout****✓**
**forceNonLinearFullSlot**
**✓**
**loadVideoTimeout**
**✓**
**maxRedirects**
**✓**
**preloadAds****✓****✓**
**requestTimeout****✓****✓**
**schedule**<br />_See: [advertising.schedule](🔗)_**✓****✓**
**skipoffset****✓**
**vastLoadTimeout**
**✓**
**vpaidcontrols****✓****✓**
<br />
### advertising.bids
For an explanation of the property listed below, see: [advertising.bids](🔗).
PropertyVASTIMA
**settings**<br />_See: [advertising.bids.settings](🔗)_**✓****✓**
<br />
### advertising.bids.settings
For explanations of each property listed below, see: [advertising.bids.settings](🔗).
PropertyVASTIMA
**bidTimeout**                           **✓****✓**
**floorPriceCents****✓****✓**
**floorPriceCurrency****✓****✓**
<br />
### advertising.companiondiv
For explanations of each property listed below, see: [advertising.companiondiv](🔗).
PropertyVASTIMA
**height**                                    **✓****✓**
**id****✓****✓**
**width****✓****✓**
<br />
### advertising.schedule
For explanations of each property listed below, see: [advertising.schedule](🔗).
PropertyVASTIMA
**customParams**                     **✓****✓**
**type****✓****✓**
**vastxml****✓** 
<br />
### autoPause
For explanations of each property listed below, see: [autoPause](🔗).
PropertyVASTIMA
**viewability**                            **✓****✓**
<br />
### floating
For explanations of each property listed below, see: [floating](🔗).
PropertyVASTIMA
**dismissible**                           **✓****✓**
<br />
### intl.{lang}.advertising
For explanations of each property listed below, see: [intl.{lang}.advertising](🔗).
PropertyVASTIMA
**admessage**                           **✓****✓**
**displayHeading****✓****✓**
**podmessage****✓****✓**
<br />
<hr />
## FAQs
<details><summary><strong>Can I use an outstream player with video content?</strong></summary>
<br />
No, the outstream player is designed to be used without a media file. You should use the regular JWP to create experiences that include video content and advertising.
<br />
</details>
<details><summary><strong>I have multiple float-on-scroll, outstream players on a single page. What will my viewers experience?</strong></summary>
<br />
Once a player is minimized and pinned to the screen, the player will remain pinned until it is dismissed. None of the other float-on-scroll players on your page will replace the pinned, minimized player. 
A player will only float on scroll only when it is in a playing state.
<br />
</details>
<details><summary><strong>Why does a gray box remain after an ad has played?</strong></summary>
<br />
If the player disappears after an ad completes, the adjustment of the page content may cause a negative user experience. Therefore, a gray background persists after an ad has completed.
You can customize this behavior by defining the `endstate` property.

<br />
PropertyDescription
**endstate** `string`Player behavior after all ads within the ad break have played <br /><br />See also: `endstate` in the [advertising](🔗) object
<br />
</details>
<br />
(Script tags will be stripped)