The article provides an overview of various Vimeo APIs and tools, including the Vimeo API, Live API, oEmbed implementation, and Player SDK, detailing their functionalities and documentation resources available for developers.
In this article:
Vimeo API
The Vimeo API is used to interact with and get metadata about your account and your videos. Use the Vimeo API if you want to:
- Upload videos to your account
- Get metadata like a video’s name, description, or direct file links
- Edit a video’s privacy settings
- Delete videos on your account
- Add videos to a folder
- Set a video’s privacy settings
Full documentation for the Vimeo API is found on the Developer Site:Vimeo Developer: Getting Started.
Live API
The Live API is a part of the Vimeo API that enables interaction with and control of live events on Vimeo.
Use the Live API to:
- Create a live event
- Get an HLS/M3U8 link for a recurring live event
- Set a live event’s title, stream privacy, or embed options
Full documentation for the Live API can be found on the Developer Site: Vimeo Developer: Working With Vimeo Live.
Access to the Live API is only available to Vimeo Enterprise members.
oEmbed
Vimeo’s oEmbed implementation is used to programmatically obtain a Vimeo Player's embed code and related metadata, with parameters specified by the client.
Use oEmbed to:
- Get an embed code with specific height and width dimensions
- Get a thumbnail image link with specific height and width dimensions
- Get basic metadata for a video, such as its name and description
Full documentation of Vimeo’s oEmbed implementation is found on the Developer Site: Vimeo Developer: Working with oEmbed.
Player SDK
The Vimeo Player SDK is used to programmatically listen to, interact with, and control an embedded Vimeo video player.
Use the Player SDK to:
- Trigger an action on your webpage when the viewer has finished playing a video
- Pause the video player when another action is performed on your webpage
- Enable subtitle or caption text track for a player
Full documentation of the Player SDK can be found on the Developer Site: Vimeo Developer: Player SDK.