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 Player SDK does not apply to live events (broadcasts, webinars, etc.). Learn more about our Live API.
The full list of methods and events provided by the Player SDK can be found on the Developer Site.
Player SDK support resources
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.