Initial FAQ

friday 2018-06-05 03:37:30 +02:00
commit e22fd6be72

20
FAQ.md Normal file

@ -0,0 +1,20 @@
## FAQ
### 1. Does Plyr work with format ... ?
Plyr is a HTML5 media players, and hence doesn't directly handle any media formats. It relies on your browser to do it. It's up to you to find out what formats you can use. Recommended resources for this is [Can I Use](https://www.caniuse.com/) and [MDN](https://developer.mozilla.org/en-US/docs/Web/) (in particular [HTML5 video](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video) and [Supported media formats](https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats#Browser_compatibility))
### 2. Can you support video provider ... (Twitch, Dailymotion etc)
Plyr supports YouTube and Vimeo besides HTML5 media. We won't add more providers to Plyr directly since that will slow down the core development as well as make Plyr bigger for people who don't need the extra providers (This also means PR's for adding providers will not get merged). Instead we plan to add support for plugins.
### 3. How can I do custom functionality ... with Plyr?
When applicable, find out how to solve it without Plyr (using stack overflow or search engines), then add Plyr. If you think it's something that should be supported by plyr, you could create a feature request as a github issue if there isn't already one.
### 4. What's the status on ... ?
Unless someone has explicitly said in an issue that it's work in progress, most likely that means no one is working on it, and that it isn't a top priority for us.
### 5. Autoplay and scripted play doesn't work in some browsers.
That is correct, and not something Plyr can solve for you (see #1). Muting the audio usually works.
For more information see [Chrome autoplay policy changes](https://developers.google.com/web/updates/2017/09/autoplay-policy-changes) and Safari autoplay policies for [macOS](https://webkit.org/blog/7734/auto-play-policy-changes-for-macos/), [iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/)
### 6. "It doesn't work"
When applicable, check that your problem doesn't happen without Plyr (see #1). Also check your developer console for errors. If you're getting an error in your own code or the problem happens without Plyr as well, then it's probably not something that deserves our attention. You should be able to resolve it without our help. If you're following the [documentation](https://github.com/sampotts/plyr/#plyr), and aren't getting any errors in your code, it may be a Plyr issue. Try to describe the issue as detailed as possible, and if the issue can't be seen on [plyr.io](https://plyr.io/) or found in our issue list at github, recreate the issue in a minimal online environment like jsfiddle, codepen or jsbin. If you don't think it's an issue but still need help, please use our [Slack](https://bit.ly/plyr-chat) for support.