JW Player

  • Docs
  • Developer Tools
  • Release Notes
  • Help Center
  • Tech Blog
  • Dashboard
  • Get Started

BUILD THE FUTURE OF VIDEO

Sign up for the Developer edition and create beautiful video experiences with the most powerful video APIs on the web.

    DocsAPI Reference
HomeDocsRecipesAPI ReferenceReferenceChangelogCommunityPage Not FoundSearch{{ state.current().meta.title }}API Logs
    DocsAPI Reference
discard

Welcome

  • Introduction

Content Management

  • Getting started
  • Manage your library with the Management API
    • Authentication
    • Output formats
    • Error handling
  • Uploading content
    • Upload videos with AWS S3
    • Upload with a resumable protocol
    • Upload multiple videos via URL
    • Upload files
    • Update a preview file
  • Embed content with the Delivery API
  • Learn about webhooks
  • Protect your content with signed URLs
  • Enable DRM with JW Stream
  • Content Management FAQs
    • FAQ: How can I create a search playlist with JWT-protected content?
    • FAQ: Which features change when a property is DRM-enabled?
  • API references

Web Player

  • Getting started
    • Use JW Player release channels
    • Add a player library
    • Embed a player
    • Embed a player on an AMP page
    • Embed a player in a Tizen App
    • Use JW Player release channels
  • Content
    • Add captions
    • Set up Recommendations
    • Embed videos with Article Matching
    • Manually broadcast a Live Channels event stream
    • Automatically broadcast a Live Channels event stream
    • Create a JW Showcase for web
    • Enable DRM through the web player
    • Enable AES decryption
  • Branding
    • Add custom icons
    • Example custom skin
    • Customize player text
  • Behavior
    • Enable viewers to share your content
  • Advertising
    • Schedule VAST ads
    • Enable Google DAI playback
    • Schedule FreeWheel ads
    • Define ad rules
    • Embed an outstream player
    • Enable Video Ad Targeting with Prebid.js
    • Enable Video Ad Targeting with a redirect tag
    • Create a custom VAST XML ad tag
  • Player Bidding overview
    • Set up PB for JW Player mediation
    • Set up PB for SpotX mediation
    • Set up PB for GAM mediation
    • Set up PB for JW Player + GAM mediation
    • Set up PB with Video Prebid for GAM
    • Validate your PB implementation
  • Analytics
    • Analytics system integrations
    • Send JW Player events to Adobe Analytics
    • Track video analytics from an AMP implementation
  • Troubleshooting
    • Troubleshoot analytics discrepencies
    • Ad errors and warnings reference
    • Player errors reference
    • Troubleshoot Player Bidding issues
    • Troubleshoot Tizen app issues
  • Web Player FAQs
    • FAQ: Can I use an outstream player with video content?
    • FAQ: I have multiple float on scroll, outstream players on a single page. What will my viewers experience?
    • FAQ: Why does a gray box remain after an ad has played?
    • FAQ: Why aren't all HLS.js or Shaka features supported by JW Player?
    • FAQ: Why can't I reproduce a JW Player bug in the HLS.js or Shaka player?
    • FAQ: Are there playlist properties that must be included when using JW Boost?
    • FAQ: Does JW Player support AES-128 encryption?
  • Reference
    • JavaScript API reference
    • Player configuration reference
    • Player CSS skin reference

Android SDK

  • Getting started
    • Add the Android SDK
    • Configure ProGuard
    • Configure the manifest
    • Add a player to an activity
  • Content
    • Create a playlist
    • Add and customize captions
    • Add preview thumbnails
    • Set up Recommendations
    • Play DRM-protected content
    • Enable DRM with JW Stream
    • Add custom HTTP headers
  • Branding
    • Localization
    • Register custom video controls
  • Behavior
    • Control content playback
    • Enable casting to Chromecast devices
    • Specify playback start time
    • Configure local media playback
    • QualityLevel
    • AudioTrack
    • Related Content Overlay
    • Multi-window mode
    • Customize Chromecast dialog
  • Advertising
    • Add an ad client dependency
    • Schedule VAST ads
    • Additional VAST
    • Schedule Google IMA ads
    • Additional Google IMA
    • Enable Google DAI playback
    • Schedule FreeWheel ads
    • Additional FreeWheel
    • Additional ad functionality
    • Define ad rules
  • Analytics
  • Troubleshooting
  • Android FAQs
    • FAQ: Which features are not supported when casting with an Android SDK player?
    • FAQ: Is the Android SDK v3 64-bit compliant?
    • FAQ: Which Android SDK features are not supported with Google DAI?
  • Reference

iOS SDK

  • Getting started
    • Download the SDK
    • Configure your project
    • Add a player to your view
    • Basic embedding
  • Content
    • Add and customize captions
    • Play DRM-protected content
    • Enable DRM with JW Stream
  • Branding
    • Register custom video controls
  • Behavior
    • Enable casting to Chromecast devices
    • Specify playback start time
    • Add an AirPlay button to an app
    • Respond to player events
  • Advertising
    • Add an ad client dependency
    • Schedule VAST ads
    • Schedule Google IMA ads
    • Additional Google IMA
    • Enable Google DAI playback
    • Schedule FreeWheel ads
    • Additional FreeWheel
    • Ad Scheduling
    • Define ad rules
    • Create an ad tag waterfall
    • Ad Tag Variables
    • Non-Linear Ads
  • Analytics
  • Troubleshooting
    • Create a reproduction app
  • iOS FAQs
    • FAQ: Why don't the ad breaks play when I build and run my project?
    • FAQ: Do I need remove any targets before submitting my iOS app?
    • FAQ: Are there changes in iOS 13 that may impact my app?
    • FAQ: Which features are not supported when casting with an iOS SDK player?
    • FAQ: Which features are not supported when casting with AirPlay?
    • FAQ: Which iOS SDK features are not supported with Google DAI?
    • FAQ: Is UIWebView used in the iOS SDK?
    • FAQ: How do I handle lock screen controls with multiple players?
    • FAQ: Where can I find my SDK and license key?
  • Reference

Analytics

  • Getting started
  • Run a report
  • Run a report with query tools
  • Metrics and dimensions

Welcome

  • Introduction

Content Management

  • Getting started
  • Manage your library with the Management API
    • Authentication
    • Output formats
    • Error handling
  • Uploading content
    • Upload videos with AWS S3
    • Upload with a resumable protocol
    • Upload multiple videos via URL
    • Upload files
    • Update a preview file
  • Embed content with the Delivery API
  • Learn about webhooks
  • Protect your content with signed URLs
  • Enable DRM with JW Stream
  • Content Management FAQs
    • FAQ: How can I create a search playlist with JWT-protected content?
    • FAQ: Which features change when a property is DRM-enabled?
  • API references

Web Player

  • Getting started
    • Use JW Player release channels
    • Add a player library
    • Embed a player
    • Embed a player on an AMP page
    • Embed a player in a Tizen App
    • Use JW Player release channels
  • Content
    • Add captions
    • Set up Recommendations
    • Embed videos with Article Matching
    • Manually broadcast a Live Channels event stream
    • Automatically broadcast a Live Channels event stream
    • Create a JW Showcase for web
    • Enable DRM through the web player
    • Enable AES decryption
  • Branding
    • Add custom icons
    • Example custom skin
    • Customize player text
  • Behavior
    • Enable viewers to share your content
  • Advertising
    • Schedule VAST ads
    • Enable Google DAI playback
    • Schedule FreeWheel ads
    • Define ad rules
    • Embed an outstream player
    • Enable Video Ad Targeting with Prebid.js
    • Enable Video Ad Targeting with a redirect tag
    • Create a custom VAST XML ad tag
  • Player Bidding overview
    • Set up PB for JW Player mediation
    • Set up PB for SpotX mediation
    • Set up PB for GAM mediation
    • Set up PB for JW Player + GAM mediation
    • Set up PB with Video Prebid for GAM
    • Validate your PB implementation
  • Analytics
    • Analytics system integrations
    • Send JW Player events to Adobe Analytics
    • Track video analytics from an AMP implementation
  • Troubleshooting
    • Troubleshoot analytics discrepencies
    • Ad errors and warnings reference
    • Player errors reference
    • Troubleshoot Player Bidding issues
    • Troubleshoot Tizen app issues
  • Web Player FAQs
    • FAQ: Can I use an outstream player with video content?
    • FAQ: I have multiple float on scroll, outstream players on a single page. What will my viewers experience?
    • FAQ: Why does a gray box remain after an ad has played?
    • FAQ: Why aren't all HLS.js or Shaka features supported by JW Player?
    • FAQ: Why can't I reproduce a JW Player bug in the HLS.js or Shaka player?
    • FAQ: Are there playlist properties that must be included when using JW Boost?
    • FAQ: Does JW Player support AES-128 encryption?
  • Reference
    • JavaScript API reference
    • Player configuration reference
    • Player CSS skin reference

Android SDK

  • Getting started
    • Add the Android SDK
    • Configure ProGuard
    • Configure the manifest
    • Add a player to an activity
  • Content
    • Create a playlist
    • Add and customize captions
    • Add preview thumbnails
    • Set up Recommendations
    • Play DRM-protected content
    • Enable DRM with JW Stream
    • Add custom HTTP headers
  • Branding
    • Localization
    • Register custom video controls
  • Behavior
    • Control content playback
    • Enable casting to Chromecast devices
    • Specify playback start time
    • Configure local media playback
    • QualityLevel
    • AudioTrack
    • Related Content Overlay
    • Multi-window mode
    • Customize Chromecast dialog
  • Advertising
    • Add an ad client dependency
    • Schedule VAST ads
    • Additional VAST
    • Schedule Google IMA ads
    • Additional Google IMA
    • Enable Google DAI playback
    • Schedule FreeWheel ads
    • Additional FreeWheel
    • Additional ad functionality
    • Define ad rules
  • Analytics
  • Troubleshooting
  • Android FAQs
    • FAQ: Which features are not supported when casting with an Android SDK player?
    • FAQ: Is the Android SDK v3 64-bit compliant?
    • FAQ: Which Android SDK features are not supported with Google DAI?
  • Reference

iOS SDK

  • Getting started
    • Download the SDK
    • Configure your project
    • Add a player to your view
    • Basic embedding
  • Content
    • Add and customize captions
    • Play DRM-protected content
    • Enable DRM with JW Stream
  • Branding
    • Register custom video controls
  • Behavior
    • Enable casting to Chromecast devices
    • Specify playback start time
    • Add an AirPlay button to an app
    • Respond to player events
  • Advertising
    • Add an ad client dependency
    • Schedule VAST ads
    • Schedule Google IMA ads
    • Additional Google IMA
    • Enable Google DAI playback
    • Schedule FreeWheel ads
    • Additional FreeWheel
    • Ad Scheduling
    • Define ad rules
    • Create an ad tag waterfall
    • Ad Tag Variables
    • Non-Linear Ads
  • Analytics
  • Troubleshooting
    • Create a reproduction app
  • iOS FAQs
    • FAQ: Why don't the ad breaks play when I build and run my project?
    • FAQ: Do I need remove any targets before submitting my iOS app?
    • FAQ: Are there changes in iOS 13 that may impact my app?
    • FAQ: Which features are not supported when casting with an iOS SDK player?
    • FAQ: Which features are not supported when casting with AirPlay?
    • FAQ: Which iOS SDK features are not supported with Google DAI?
    • FAQ: Is UIWebView used in the iOS SDK?
    • FAQ: How do I handle lock screen controls with multiple players?
    • FAQ: Where can I find my SDK and license key?
  • Reference

Analytics

  • Getting started
  • Run a report
  • Run a report with query tools
  • Metrics and dimensions

Delivery API

  • Media
    • get
      Single media objects/feeds
  • DRM Media
    • get
      Single DRM media objects
  • Poster Images
    • get
      A poster image for the media
    • get
      A poster image for the media
  • Playlists
    • get
      Playlist objects/feeds
  • DRM playlists
    • get
      DRM Playlist objects
  • Advertising
    • get
      An ad schedule
  • Players
    • get
      A cloud hosted player library
    • get
      A player with media attached
    • get
      A preview page with a player and media
  • Video Files
    • get
      A media source file
  • Streaming Manifests
    • get
      An adaptive streaming manifest
  • Text Tracks
    • get
      A text track for the media
  • Live Channel
    • get
      Show a Live Channel status
    • get
      Get a live event stream manifest

JW Platform Management API V1

  • Introduction
  • accounts/tags
    • post
      Create a video tag
    • post
      Delete video tag
    • get
      Return a list of video tags
    • get
      Show video tag information
    • post
      Update video tag
  • accounts/usage
    • get
      Shows usage statistics for an account
  • channels
    • post
      Create a new playlist
    • post
      Delete a channel
    • get
      Return a list of channels
    • get
      Show all information about a playlist
    • post
      Update information about a channel
  • channels/videos
    • post
      Add a video to a manual playlist
    • post
      Delete a video from a manual playlist
    • get
      Return list of videos in a manual or dynamic playlist
    • get
      Show video information
    • post
      Move a video
  • players
    • post
      Create a video player
    • post
      Delete video player
    • get
      List available video players
    • get
      Show video player information
    • post
      Update video player
  • status
    • get
      Returns the current status of the System API
  • videos
    • post
      Create a new video object
    • post
      Delete a video
    • get
      List videos
    • get
      Show the properties of a video
    • post
      Update the properties of a video
  • videos/conversions
    • post
      Create a new video conversion
    • post
      Delete a video conversion
    • get
      List conversions for a specific video
    • get
      Show video conversion information
  • videos/tags
    • get
      List of video tags
  • videos/thumbnails
    • get
      Show creation status
    • post
      Update a video thumbnail
  • videos/tracks
    • post
      Create a new video timed track
    • post
      Delete a video timed track
    • get
      List tracks of a specific video
    • get
      Show video track information
    • post
      Update video track

JW Platform Management API v2 (Beta)

  • Introduction to API v2
    • Authentication
    • API Calls
  • analytics
    • post
      Fetches an analytics report over a custom date range
  • drm policies
    • post
      Create a DRM Policy resource
    • get
      List DRM Policy resources for a site
    • get
      Retrieve a DRM Policy resource by ID
    • patch
      Update a DRM Policy resource
    • delete
      Delete a DRM Policy resource
  • imports
    • get
      List imports
    • post
      Add import
    • get
      Get import
    • patch
      Update import
    • delete
      Delete import
  • live channels
    • get
      List all Live Channels
    • post
      Create a new Live Channel
    • get
      Get the details for a Live Channel
    • delete
      Delete a Live Channel
    • patch
      Change settings for a Live Channel
  • live events
    • get
      List events of a Live Channel
    • get
      Get details for an event of a Live Channel
    • put
      Request download availability of the master (highest-quality) version of the event.
    • put
      Create a new VOD asset by clipping an event
    • get
      Download the master asset for the event
  • media
    • get
      List all media on a site
    • post
      Create a media resource
    • get
      Retrieve a media resource by ID
    • patch
      Update a media resource
    • delete
      Delete a media resource
    • put
      Reupload a media resource
  • playlists
    • get
      List playlists
    • get
      Retrieve a playlist resource by ID
    • delete
      Delete a playlist resource by ID
    • post
      Create a manual playlist
    • get
      Retrieve a manual playlist resource by ID
    • patch
      Update a manual playlist
    • delete
      Delete a manual playlist
    • post
      Create a dynamic playlist
    • get
      Retrieve a dynamic playlist resource by ID
    • patch
      Update a dynamic playlist
    • delete
      Delete a dynamic playlist
    • post
      Create a trending playlist
    • get
      Retrieve a trending playlist resource by ID
    • patch
      Update a trending playlist
    • delete
      Delete a trending playlist
    • post
      Create an article matching playlist
    • get
      Retrieve an article matching playlist resource by ID
    • patch
      Update an article matching playlist
    • delete
      Delete an article matching playlist
    • post
      Create a search playlist
    • get
      Retrieve a search playlist resource by ID
    • patch
      Update a search playlist
    • delete
      Delete a search playlist
    • post
      Create a recommendations playlist
    • get
      Retrieve a recommendations playlist resource by ID
    • patch
      Update a recommendations playlist
    • delete
      Delete a recommendations playlist
  • webhooks
    • get
      List all webhooks on the account
    • post
      Create a new webhook resource
    • get
      Retrieve a webhook resource by ID
    • delete
      Delete a webhook resource
    • patch
      Update a webhook resource
  • vpb configs
    • get
      List the VPB configurations for a site
    • post
      Create a new VPB configuration resource
    • patch
      Updates a VPB configuration by ID
    • get
      Retrieve a VPB configuration by ID
    • delete
      Delete a VPB configuration by ID
    • put
      Update schedules with VPB configuration