Implement Player generation & oEmbed endpoints

[sundowndev]

This feature should allow a user to easily implement a HTML5 production-ready video player into his own web page.

Example use case

1. User makes an HTTP request to POST /players player options included, to create a new player
2. User retrieve the newly created player if needed by making a request to GET /players/:player_uuid
3. User can now make a request to GET /players/:player_uuid/oembed?url=media_url&format=json to embed the player in its own page

Implementation

Routes

• POST /players - Create a player
• PUT /players - Edit a player
• DELETE /players - Delete a player
• GET /players - Retrieve all players
• GET /players/:uuid - Get one player
• GET /players/:uuid/oembed - Get oEmbed object
• GET /players/:uuid/embed/:media_uuid - Get HTML5 player to embed

Player generation

• Solution 1 : store static assets in the VCS, then embed them in the binary then serve the content as a single HTML response. Assets include : videojs-css, videojs-js. VideoJS options are altered according to the player's options.

Example oEmbed response

• GET /players/fa3b3ec9-2388-4196-96cc-d7ca1a86f3da/oembed?media=fa3b3ec9-2388-4196-96cc-d7ca1a86f3da&format=json

{
  "title": "cyberpunk 2077 gameplay",
  "author_name": "",
  "author_url": "",
  "type": "video",
  "height": 640,
  "width": 360,
  "version": "1.0",
  "provider_name": "Gilfoyle",
  "provider_url": "https://demo.gilfoyle.dreamvo.com/",
  "thumbnail_height": 360,
  "thumbnail_width": 480,
  "thumbnail_url": "https://cdn.demo.gilfoyle.dreamvo.com/fa3b3ec9-2388-4196-96cc-d7ca1a86f3da/previews/fa3b3ec9-2388-4196-96cc-d7ca1a86f3da.jpg",
  "html": "<iframe width=\"200\" height=\"113\" src=\"https://demo.gilfoyle.dreamvo.com/players/fa3b3ec9-2388-4196-96cc-d7ca1a86f3da/embed/fa3b3ec9-2388-4196-96cc-d7ca1a86f3da?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>"
}

We'll only support JSON format for now. XML will come later.

Player options

• loop: bool
• controls: bool
• autoplay: bool
• muted: bool
• preload: string
• playbackRates: []float32

References

• https://oembed.com/