Articles in this section

Player SDK

Overview

Developers can control and interact with an embedded Vimeo player using our Javascript Player SDK. Using the Player SDK, developers can listen for events that occur within the player, programmatically control the player, and much more. Full documentation and references can be found on the Developer Site. If you want to dive deeper, the source code is also available on GitHub.

Capabilities

In general, the Player SDK can be used to control an embedded Vimeo player and listen for actions and events that occur within that embedded player. Using the Player SDK, developers can perform actions on their pages that affect the Player, and vice-versa, events that occur in the Player can trigger developer-specified actions on the webpage. For example:

When a viewer pauses a video, display a message on the page

When a user clicks a button on your page, tell the player to initiate playback

When a viewer reaches the end of a video, redirect the user to another page

Every five seconds, log the viewer’s play progress to a cookie

The full list of methods and events provided by the Player SDK can be found on the Developer Site.

Player SDK support resources

Development of the Player SDK occurs on GitHub. Users who have implemented the Player SDK and encounter problems are welcome to file an issue.

When reporting an issue with the Player SDK on GitHub, please provide a minimal reproducible example of the issue and relevant code snippets; feel free to use a site or service like JSFiddle, CodePen, or Glitch.me to exemplify your issue.