The Up Next API contains the following objects and interfaces for configuring and displaying information about the next content to play as a bottom right bar on the player UI. This API is available from version 2.15.0 onward and only if you have a player with this feature enabled.

UpNext

The upnext object provides the following properties:

Property Type Description
showing boolean The showing property indicates whether the up next bar is showing or not.
show void When the show method is called, the up next bar will be displayed.
hide void When the hide method is called, the up next bar will be hidden.
source UpNextSource The source property can be used to get or set an UpNextSource that contain information on the up next video such as a clickthrough link, a thumbnail image, a title, and duration of the video.
next void When the next method is called, the page location will change to the link specified in the source.

 

UpNextSource

The UpNextSource interface contains information about the up next source.

Properties

An object implementing the UpNextSource interface should provide the following properties:

Property Type Optional Description
duration string yes The duration property can be used to display a duration on the up next bar.
image string  no The image property is used to set a thumbnail on the up next bar.
link string  no The link property is used to specify a target URL to navigate to, when clicking the up next bar.
offset string yes The offset property is used to specify the offset form which the up next bar will be displayed. The offset is always calculated from the end of the video. Possible values are: 
  • a number e.g. 10 or "10": the bar will be displayed from 10 seconds before the end of the video.
  • "10%": the bar will be displayed during the last 10% of the video.

By default, the up next bar will be displayed 10 seconds from the end of the video.

title string yes The title property can be used to display a title on the up next bar.