diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 36 |
1 files changed, 26 insertions, 10 deletions
@@ -30,13 +30,22 @@ Oh and yes, it works with Bootstrap. ## Changelog Check out the [changelog](changelog.md) to see what's new with Plyr. -## Planned Development -- Playback speed -- Quality selection +## Features currently being developed +- Playback speed (#53) +- Quality selection (#218) +- Caption language selection (#385) +- AirPlay +- Picture in Picture (MacOS Sierra + Safari) (#366) +[more info](https://github.com/Selz/plyr/issues?q=is%3Aissue+is%3Aopen+label%3A%22In+Development%22) + +## Planned features - Playlists -- Multiple language captions (with selection) +- Google cast +- Facebook video support +- Wistia video support +- YouTube and Vimeo audio support - Audio captions -... and whatever else has been raised in [issues](https://github.com/Selz/plyr/issues) +...and whatever else has been raised in [issues](https://github.com/Selz/plyr/issues) If you have any cool ideas or features, please let me know by [creating an issue](https://github.com/Selz/plyr/issues/new) or, of course, forking and sending a pull request. @@ -106,10 +115,13 @@ For YouTube and Vimeo, Plyr uses the standard YouTube API markup (an empty `<div <div data-type="youtube" data-video-id="bTqVqk7FSmY"></div> ``` +Note: `data-video-id` value can now be the ID or URL for the video. This attribute name will change in a future release to reflect this change. + #### Vimeo embed ```html <div data-type="vimeo" data-video-id="143418951"></div> ``` +Note: `data-video-id` value can now be the ID or URL for the video. This attribute name will change in a future release to reflect this change. ### JavaScript Include the `plyr.js` script before the closing `</body>` tag and then call `plyr.setup()`. More info on `setup()` can be found under [initialising](#initialising). @@ -676,6 +688,8 @@ player.source({ }); ``` +Note: `src` can be the video ID or URL + Vimeo example ```javascript @@ -689,7 +703,9 @@ player.source({ }); ``` -Some more details on the object parameters +Note: `src` can be the video ID or URL + +More details on the object parameters <table class="table" width="100%"> <thead> @@ -713,7 +729,7 @@ Some more details on the object parameters <tr> <td><code>sources</code></td> <td>Array</td> - <td>This is an array of sources. <code>type</code> is optional for YouTube and Vimeo when specifying an array. For YouTube and Vimeo media, only the video ID must be passed as the source as shown above. The keys of this object are mapped directly to HTML attributes so more can be added to the object if required.</td> + <td>This is an array of sources. <code>type</code> is optional for YouTube and Vimeo when specifying an array. For YouTube and Vimeo media, the video ID or URL must be passed as the source as shown above. The keys of this object are mapped directly to HTML attributes so more can be added to the object if required.</td> </tr> <tr> <td><code>poster</code></td> @@ -776,7 +792,7 @@ These events also bubble up the DOM. The event target will be the container elem <tr> <td><code>ended</code></td> <td></td> - <td>Sent when playback completes.</td> + <td>Sent when playback completes. Note: with Vimeo this does not occur if `loop` is enabled.</td> </tr> <tr> <td><code>error</code></td> @@ -820,12 +836,12 @@ These events also bubble up the DOM. The event target will be the container elem </tr> <tr> <td><code>seeked</code></td> - <td>✔</td> + <td></td> <td>Sent when a seek operation completes.</td> </tr> <tr> <td><code>seeking</code></td> - <td>✔</td> + <td></td> <td>Sent when a seek operation begins.</td> </tr> <tr> |