Show video player information



RESPONSE PARAMETERS

ParameterDescription
code stringError code
message stringError message
player objectProperties of a player

See: player object
rate_limit objectNumber of requests that can be made to a route per minute per property

Only 60 calls per minute per property can be made.

See: rate_limit object
status stringCall execution status

Set to ok if the call executed successfully.
title stringError title

player

ParameterDescription
aboutlink stringURL or path that one is taken to when clicking abouttext
abouttext stringText displayed in right-click select menu when one right clicks the player
advertising objectAdvertising properties

See: player.advertising object
advertising_schedule_key stringKey of the advertising schedule
aspectratio stringIndicates player aspect ratio

Specified only when player.responsive is true
autopause booleanAutomatically pauses the player based on certain rules

Possible values:

   • false: The autopause functionality is disabled
   • true: When the player is no longer viewable, video playback pauses. Playback resumes when the player becomes viewable again. If the player is no longer viewable after an ad break begins, the ad break will continue to play to completion before pausing.
autostart stringIndicates whether video playback should start on player load

Possible values:

   • false: Do not start video playback on player load
   • true: 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
captions stringIndicates whether player should show video captions

Possible values:

   • block: Show captions and draw a black box around them
   • none: Do not show captions
   • outline: Show captions and render them with a thin black outline
cast objectCasting properties

See: player.cast object
controlbar stringControl bar position

Possible values:

   • bottom: Control bar is below the video
   • none: No control bar
   • over: Control bar is over the video
currentitemtext stringOverride for the Watching text in the Recommendations channel overlay
default_bandwidth_estimate numberSets 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.
displaydescription booleanIndicates whether video description should be displayed inside the play icon

Possible values:

   • true: Display video description
   • false: Do not display video description

If not set, JW Player will use its default value.
displayheading boolean(Outstream only) Controls if heading above the outstream player is displayed

Possible values:

   • true: Heading is shown with default text: Advertisement
   • false: No heading is shown
displaytitle booleanIndicates whether video title should be display inside the play icon

Possible values:

   • true: Display video title
   • false: Do not display video title

If not set, JW Player will use its default value.
floating booleanKeeps the player visible when the original player location is scrolled out of view by minimizing it to a corner of the screen.

On devices in portrait orientation, the player becomes fixed to the top of the page using its original dimensions. When floating, the viewer can drag the player to reposition it. This functionality is disabled during ad playback.

This floating feature cannot be used with a player that is embedded in an iframe.

Possible values:

   • false: Floating player functionality is disabled
   • true: Floating player is enabled and can be closed by a viewer
ga_web_property_id stringGoogle Analytics Web Property ID
height numberVideo player height

This is specified only when player.responsive is false
include_compatibility_script booleanDetermines whether to serve compatibility script with player

Possible values:

   • false: (Default) Does not serve compatibility script with player
   • true: Serves compatibility script with player
key stringKey of the video player
mute booleanIndicates whether sound should be muted on startup

Possible values:

   • false: Do not mute sound on startup
   • true: Mute sound on startup
name stringName of the video player
nextupoffset number | stringIndicates when the Next Up card displays during playback

A positive value is an offset from the start of the video. A negative value is an offset from the end of the video. This property can be defined either as a number (-10) or a percentage as a string ("-2%")
playback_rate_controls booleanDefines whether to display a button in the controlbar to adjust playback rate

Possible values:

   • false: Do not display playback rate button
   • true: Display playback rate button
playback_rates stringJSON-formated array of playback rates
playlist stringPlaylist position

Possible values:

   • bottom: Playlist is below the video
   • none: No playlist
   • over: Playlist is over the video
   • right: Playlist is right of the video
playlistlayout stringLayout of the items in the playlist

Possible values:

   • basic: Playlist layout only includes title
   • extended: Playlist layout includes image, title and description
playlistsize numberPlaylist size
preload stringDefines video preload behavior of the player in the browser

Possible values:

   • auto: Browser should load the entire video when the page loads
   • metadata: Browser should load metadata and possibly some early part of the media when the page loads
   • none: Browser should not load the video or its metadata when the page loads
primary stringSpecifies which rendering mode to use for rendering the player if both are available

Possible values:

   • flash: Use flash mode
   • html5: Use HTML5 mode
recommendations_channel_key stringKey of the feed channel associated with the player
related_autoplaytimer numberTimer in seconds before the next autoplay video starts
related_autoplaymessage stringA custom message that appears during autoplay countdown
related_displaymode stringDefines where to render related block

Possible values:

   • overlay: Overlaying element that covers viewable player
   • shelf: Horizontal shelf that sits above the control bar
   • shelfWidget: Horizontal video list, located outside the player
related_heading stringSpecifies single-line heading displayed above the grid with related videos
related_onclick stringSpecifies 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
related_videos stringIndicates whether player should show related videos

Possible values:

   • autoplay: Autoplay next related video
   • hide: Hide related videos
   • none: Related videos are not displayed
   • show: Show related videos
release_channel stringIndicates JW Player release channel

Possible values:

   • beta: JW Player beta release channel
   • previous: JW Player previous release channel
   • production: JW Player production release channel
   • staging: JW Player staging release channel
repeat stringIndicates playback repeating behavior of the player

Possible values:

   • always: Continuously repeat all videos in channel
   • list: Play all entries in the channel once
   • none: Stop playback after every video
   • single: Continuously repeat only the current video
responsive booleanIndicates whether the player is using responsive design settings

Possible values:

   • false: Player is not using responsive design settings
   • true: Player is using responsive design settings
sharing stringIndicates sharing plugin options

Possible values:

   • dock: Only display sharing shortcuts buttons in the dock
   • none: No sharing
   • 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
sharing_heading stringShort text to display at the top of the sharing screen
sharing_player_key stringKey of the player that should be used for sharing
sharing_sites stringJSON-formated array to customize social sharing sites settings
sitecatalyst booleanIndicates whether integration with the Adobe SiteCatalyst is enabled

Possible values:

   • false: Integration is not enabled
   • true: Integration enabled
skin objectColor properties of the player skin

See: player.skin object
stretching stringIndicates how videos or thumbnails should be stretched

Possible values:

   • exactfit: Stretch disproportionally to exactly match the display dimensions
   • fill: Stretch proportionally to fill the display (parts are cut off)
   • none: Maintain original dimensions
   • uniform: Stretch proportionally to fit the display (black borders)
template stringKey of the video conversion template used for this player

If value of this property is null, the player is using bitrate switching
version stringPlayer version
views stringTotal video views since video has been created

WARNING: This property is a legacy system metric that has been deprecated since 2016-07-01. The value returned here is not an accurate representation of video views or plays.
visualplaylist booleanIndicates whether to display the visual playlist indicator in the control bar

Possible values:

   • true: Turn on visual playlist indicator
   • false: Turn off visual playlist indicator

If not set, JW Player will use its default value.
watermark objectWatermark used with this video player

Included in response only when watermark status is ready or updating

See: player.watermark object
width numberVideo player width

This is specified only when player.responsive is false.

player.advertising

ParameterDescription
admessage stringMessage that displayed in the control bar during ad playback
autoplayadsmuted booleanFor inline players that start muted when viewed on mobile devices, allows ads to play muted
client stringAdvertising client

Possible values:

   • googima: Google IMA ad client. In-video ads served by Google's Dart For Publishers (DFP).
   • vast: VAST/VPAID ad client. Ads served by a VAST-compliant video ad server.
companiondiv objectGives information to the player related to which div(s) to populate with companion ads

See: player.advertising.companiondiv object
cuetext stringAd cue text
endstate string(Outstream only) Player behavior after all ads within the ad break have played

Possible values:

   • close: Player gradually closes
   • suspended: Gray background without controls remains
outstream booleanProperty enabling outstream functionality
preloadads booleanWill ads preload or not
schedule stringURL to a VMAP ad schedule
skipmessage stringMessage for skip-at button
skipoffset numberOffset in seconds to show skip-at button at. Ad cannot be skipped if set to 0.
skiptext stringText for the ad skip button after the countdown is over
tag stringURL of the ad tag that contains the pre-roll ad
vpaidcontrols booleanWill vpaidcontrols render or not
vpaidmode stringAbility to set VPAID 2 mode for Google IMA

Possible values:

   • enabled: VPAID 2 mode enabled
   • insecure: Insecure VPAID 2 mode
   • none: VPAID 2 mode disabled

player.advertising.companiondiv
ParameterDescription
height numberHeight of ads that are placed in companion
id stringDOM id to put companion ads in
width numberWidth of ads that are placed in companion

player.cast

ParameterDescription
appid stringIdentifier of the default media receiver

player.skin

ParameterDescription
controlbar objectColor properties of the control bar

See: player.skin.controlbar object
key stringKey of the skin used by the player
menus objectColor properties of the menus

See: player.skin.menus object
name stringName of the player skin
timeslider objectColor properties of the timeslider

See: player.skin.timeslider object
tooltips objectColor properties of the tooltips

See: player.skin.tooltips object

player.skin.controlbar

ParameterDescription
background stringBackground color of the control bar and the volume slider

The default background is transparent.
icons stringInactive 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.
iconsactive stringColor of hovered or selected icons in the control bar
text stringColor of any plain text in the control bar, such as the time

player.skin.menus

ParameterDescription
background stringBackground color of menus and the Next Up overlay
text stringColor of inactive, default text in menus and the Next Up overlay
textActive stringColor 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.

player.skin.timeslider

ParameterDescription
progress stringColor 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
rail stringColor of the base of the timeslider, known as the rail

player.skin.tooltips

ParameterDescription
background stringBackground color of tooltips
text stringText color of tooltips

player.watermark

ParameterDescription
clicklink stringHTTP link to jump to when the watermark image is clicked
hide booleanShow or hide watermark during video playback

Possible values:

   • false: Show watermark during video playback
   • true: Hide watermark during video playback
key stringWatermark key
link objectWatermark download link is split into 3 parts: protocol, address and path

See: player.watermark.link object
margin numberWatermark margin from the both sides of the video player corner set by the watermark.position parameter
name stringName of the watermark
position stringWatermark position

Possible values:

   • bottom-left: Watermark positioned in the bottom left corner of the video player
   • bottom-right: Watermark positioned in the bottom right corner of the video player
   • control-bar: Position watermark in the control bar of the video player
   • top-left: Watermark positioned in the top left corner of the video player
   • top-right: Watermark positioned in the top right corner of the video player

player.watermark.link

ParameterDescription
address stringAddress part of the watermark download link
path stringPath part of the watermark download link
protocol stringProtocol part of the watermark download link

rate_limit

ParameterDescription
limit numberTotal number of requests that can be made to this route before the reset time
remaining numberNumber of remaining requests that can be made to this route before the reset time
reset numberUnix timestamp identifying when the rate limit renews

Language
URL