Key of the player which should be updated.

Url or path that one is taken to when clicking abouttext

Text displayed in right-click select menu when one right clicks the player.

Message that displayed in the controlbar during ad playback.

Advertising client

Possible values:

• none: No ads serving

• vast: Ads served by a VAST-compliant video ad server

• googima: In-video ads served by Google DFP

DOM id to put companion ads in.

Ad cue text.

Player behavior after all ads within the ad break have played

Possible values:

• suspended: A gray background without controls remains.

• close: The player gradually closes.

Property enabling outstream functionality

• True: Outstream enabled

• False: Outstream disabled

URL to a VMAP ad schedule.

WARNING: It is strongly recommended to configure players with JW Platform hosted ad schedules using the advertising_schedule_key parameter instead of the advertising_schedule parameter(s). JW Platform hosted ad schedules have the benefit of tracking IDs that will power advertising analytics in the future.

Key of the advertising schedule.

WARNING: If set, the schedule specified by advertising_schedule_key will be used instead of advertising_schedule advertising_client advertising_tag(_1|_2) settings. It is strongly recommended to configure players with JW Platform hosted ad schedules using the advertising_schedule_key parameter. JW Platform hosted ad schedules have the benefit of tracking IDs that will power advertising analytics in the future.

Message for skip-at button. Used to provide a customized ad skipping countdown message. xx in the message will be replaced with seconds until the ad is skippable. For example: Skip ad in xx seconds.

Text for the ad skip button after the countdown is over

URL of the advertising tag

Second URL of the advertising tag to support ad waterfalling

Third URL of the advertising tag to support ad waterfalling

• True: Vpaidcontrols will render

• False: Vpaidcontrols will not render

Default is False.

The ability to set VPAID 2 mode for Google IMA

Possible values:

• none: VPAID 2 mode disabled.

• enabled: VPAID 2 mode enabled.

• insecure: Insecure VPAID 2 mode.

Default is insecure.

Defines player aspect ratio. Only applicable when player responsive parameter is True.

Defines whether video playback should start on player load

Possible values:

• True: Start video playback on player load.

• False: Do not start video playback on player load.

• viewable: Start video playback on player load and when player is more then 50% visible in a desktop environment.

Defines whether player should show video captions

Possible values:

• none: Do not show captions.

• outline: Show captions and render them with a thin black outline.

• block: Show captions and draw a black box around them.

Google Cast receiver Application ID

If set, enables Google Cast functionality.

Key of the image that should be displayed on the TV once all videos have completely played

If no image is specified, JW Player provides a default end screen image

Key of the image that should be displayed on the TV once the connection between the sending application and a receiver application is made

If no image is specified, JW Player provides a default screen.

Key of the image that should be placed as a logo in the top right corner of the receiver application

Hexadecimal color value. Used to match the Chromecast controls to a custom branding

Controlbar position

Possible values:

• none: No controlbar.

• bottom: Controlbar is below the video.

• over: Controlbar is over the video.

Defines whether JavaScript cookies should be turned on

Possible values:

• True: Turn on JavaScript cookies

• False: Turn off JavaScript cookies

• None: Same as True

Override for the "Watching" text in the recommendations channel overlay

Player custom parameters. param part of the request
parameters (after the ‘.’ separator) specifies name of the
parameter. Note that these parameters are not served with
the player from the Delivery API, but can be used to
organize your players in the API. The parameter name should
adhere to the following naming rules:

• name can contain letters, numbers and punctuation
  characters ‘.’, ‘_’, ‘-‘

• name cannot start with a number or punctuation character

• name cannot contain spaces

Custom parameter values can be specified multiple times, as
long as parameter name is unique.

If parameter already exist in the system, it will be updated
with the new value. If parameter name starts with ‘-‘, the
parameter with the same name (but without leading ‘-‘) will
be deleted from the system.

Defines whether video description should be displayed inside
the play icon:

• True: Display video description.

• False: Do not display video description.

Controls if heading above the outstream player is displayed

Possible values:

• True: Heading is shown with default text: Advertisement.

• False: No heading is shown.

Turns recommendations channel overlay on or off:

• True: Display recommendations channel overlay

• False: Do not display recommendations channel playlist overlay

Defines whether video title should be display inside the
play icon:

• True: Display video title.

• False: Do not display video title.

Default is True.

Specifies div id on the page for the player to set up the playlist outside of the player

Title of the playlist tooltip and menu override like "Episodes" or "Playlist"

Google Analytics Web Property ID in the form UA-XXXXX-YY.

Determines whether to serve compatibility script with
player.

• True: Serves compatibility script with player.

• False: Does NOT serve compatibility script with player

If not set, JW Player will not include the script.

ID of a LongTail AdSolution channel

Defines whether sound should be muted on startup:

• True: Mute sound on startup.

• False: Do not mute sound on startup.

Name of the video player.

Override for the "Next Up" text in the recommendations channel overlay

Defines whether to display a button in the controlbar to
adjust playback rate:

• True: Display playback rate button.

• False: Do not display playback rate button.

Playback rates in the form of JSON formated array of float numbers. Array can have up to 10 elements with the lowest value 0.25 and highest 4.

Example:

[0.25,1,1.75,2]

Playlist position

Possible values:

• none: No playlist.

• bottom: Playlist is below the video.

• right: Playlist is right of the video.

• over: Playlist is over the video.

Defines layout of the items in the playlist

Possible values:

• extended: Playlist layout includes image, title and description.

• basic: Playlist layout only includes title.

Playlist size. Only set if current or new playlist position is not none.

Defines video preload behavior of the player in the browser

Possible values:

• auto: The browser should load the entire video when the page loads.

• metadata: The browser should load metadata and possibly some early part of the media when the page loads.

• none: The browser should NOT load the video or its metadata when the page loads.

Although the precise behavior of the preload setting will
vary slightly based on browser and device, W3C provides this
recommendation for the parameter:
http://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload

Current JW Player behavior and browser support is documented
at: https://support.jwplayer.com/articles/video-preload-reference

Specifies which rendering mode to use for rendering the player if both are available

Possible values:

• html5: Use HTML5 mode

• flash: Use Flash mode

Recommendations channel key to associate with the player.

A custom message that appears during autoplay countdown.
Uses xx as a replacement for the countdown timer. Macros
can also be used to replace aspects of the message, based on
metadata information included in the related feed

Possible values:

• __item-title__: The title of the next video.

• __item-description__: A short description of the next video.

• __item-mediaid__: Custom media id of the next video.

• __item-file__: File URL of the next video’s file.

• __item-duration__: Duration in seconds of the next video.

Defines where to render related block

Possible values:

• shelf: Horizontal shelf that sits above the control bar.

• overlay: Overlaying element that covers viewable player.

Defines single line heading displayed above the grid with related videos. Default is Related Videos.

Defines action when user clicks related video thumbnail

Possible values:

• link: Jump to the page URL of the related video.

• play: Play the related video inline.

Defines whether player should show related videos
Possible values:

• none: Do not display related videos.

• hide: Hide related videos.

• show: Show related videos.

• autoplay: Autoplay next related video.

Player release channel

Possible values:

• beta: JW Player beta release channel.

• staging: JW Player staging release channel.

• production: JW Player production release channel.

• previous: JW Player previous release channel.

• preview: JW Player preview release channel.

Default is production.

Defines playback repeating behavior of the player

Possible values:

• none: Stop playback after every video.

• single: Continuously repeat only the current video.

• list: Play all entries in the channel once.

• always: Continuously repeat all videos in channel.

Defines whether the player should using Responsive Design
settings:

• True: Use Responsive Design settings.

• False: Do not use Responsive Design settings.

Feature that enables our analytics plugin to fire a ping back when a viewer has watched past a threshold of time

Defines options for the sharing plugin

Possible values:

• none: No sharing.

• dock: Only display sharing shortcuts buttons in the dock.

• screen: Display on screen sharing dialog with the video link field and sharing shortcuts buttons.

• screen-embed: Display on screen sharing dialog with the video link field, embed code field and sharing shortcuts buttons.

Short text to display at the top of the sharing screen.

Key of the player that should be used for sharing.

JSON-formatted array to customize social
sharing sites settings

By default, icons for Facebook, Twitter, and email are
displayed. Sites can be added, removed, or re-ordered.

Built-in social networks include:

• email: Email

• facebook: Facebook

• linkedin: LinkedIn

• pinterest: Pinterest

• reddit: Reddit

• tumblr: Tumblr

• twitter: Twitter

Example:
["reddit","facebook","twitter"]

In the event that there are additional sites or actions that
you would like to perform with sharing plugin, these can be
added by inserting the following into your sites array:

• icon: A URL to the social media icon that you wish to
  use. Can be in SVG or PNG format.

• src: The JavaScript that will be executed by selecting
  the particular button.

• label: The label that you wish to associate with this
  sharing method. This will be returned via our API when
  selected.

Example:
["reddit", {"src": "javascript:sharetoCustom();", "label": "mysite", "icon": "customicon.png"}, "linkedin"]

Default is ["facebook", "twitter", "email"]

Defines whether integration with the Adobe SiteCatalyst should be enabled

Possible values:

• True: Enable integration

• False: Do not enable integration

• None: Same as False

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the controlbar text.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the controlbar icons.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the active controlbar icons.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the controlbar background.

Key of the skin that should be used by the player.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the menus background.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the menus text.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the active menus text.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the timeslider progress.

Hexadecimal color value using the full #AABBCC or short#ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the timeslider rail.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the tooltips background.

Hexadecimal color value using the full #AABBCC or short #ABC format; or RGB color value with an alpha channel using rgba(170, 187, 204, 0.5) format. Used to change the default style for the tooltips text.

Defines how videos or thumbnails should be stretched

Possible values:

• none: Maintain original dimensions.

• exactfit: Stretch disproportionally to exactly match the display dimensions.

• fill: Stretch proportionally to fill the display (parts are cut off).

• uniform: Stretch proportionally to fit the display (black borders).

Key of the video conversion template used by this player. If empty, player will use bitrate switching.

Player version

Defines whether to display the visual playlist indicator in
the controlbar:

• True: Turn on visual playlist indicator.

• False: Turn off visual playlist indicator.

HTTP link to jump to when the watermark image is clicked. If it is not set, a click on the watermark does nothing.

Defines whether watermark should hidden during video
playback:

• True: Hide watermark during video playback.

• False: Show watermark during video playback.

Key of the watermark that should be used with this video player. Player will not use any watermark image if the watermark_key value is empty.

Watermark position

Possible values:

• top-left: Position watermark in the top left corner of the video player.

• top-right: Position watermark in the top right corner of the video player.

• bottom-right: Position watermark in the bottom right corner of the video player.

• bottom-left: Position watermark in the bottom left corner of the video player.

• control-bar: Position watermark in the control bar of the video player.

Generated from available response content types