PROVIDERS.md

🎥 Providers

Providers are responsible for loading players/media and controlling it. For example, the YouTube provider sets up the YouTube player embed and loads a video through it. All providers implement the MediaProvider interface.

Let's pretend we're creating a new provider for Twitch, the steps will generally go as follows:

1. Run the following script npm run generate:provider and pass in the name Twitch.
2. Go to src/components/providers/twitch.
3. Create interfaces for the parameters, commands, events and messages that the Twitch embed takes and fires. Make sure everything is documented, most the time it's simply copy and pasting from the provider's documentation. Always refer to existing providers for some guidance.
4. Setup the properties that we will expose on the component to set player parameters.
5. The Twitch player is loaded in an <iframe> so we'll need to setup the Embed component.

From here onwards it's best to refer to existing providers as a guide and slowly implement each method you see. Don't forget to emit the vmLoadStart event when new media is loading, and to finalize the getAdapter method.

After we wrap up all our testing and we're satisfied, the final steps are:

1. Create a usage directory inside the provider directory and add examples for the same frameworks that are listed for all other providers.
2. Run the build script npm run build.
3. Add small description about the provider to the auto-generated component documentation (above the <-- Auto Generated Below --> comment). See other providers as an example.
4. Commit your changes git commit -m 'feat(providers): add twitch provider'
5. Create a PR!