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 perform various other actions. Full documentation and references can be found on the Developer Site. The source code is also available on GitHub.
In this article:
Capabilities
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.). Read about our Live API at Use the Vimeo 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
The development of the Player SDK takes place on GitHub. Users who have implemented the Player SDK and encounter issues are welcome to file a report.
When reporting an issue with the Player SDK on GitHub, please provide a minimal, reproducible example of the issue along with relevant code snippets. You can use a site or service like JSFiddle, CodePen, or Glitch.me to exemplify your issue.