aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md224
1 files changed, 109 insertions, 115 deletions
diff --git a/readme.md b/readme.md
index d2ee74bd..edfdf27e 100644
--- a/readme.md
+++ b/readme.md
@@ -35,35 +35,21 @@ Oh and yes, it works with Bootstrap.
Check out the [changelog](changelog.md) to see what's new with Plyr.
-## CMS plugins
+## Plugins & Components
-### [WordPress](https://wordpress.org/plugins/plyr/)
+Some awesome folks have made plugins for CMSs and Components for JavaScript frameworks:
-Created and maintained by Ryan Anthony Drake ([@iamryandrake](https://github.com/iamryandrake))
-
-### [Neos](https://packagist.org/packages/jonnitto/plyr)
-
-Created and maintained by Jon Uhlmann ([@jonnitto](https://github.com/jonnitto))
-
-### [Kirby](https://github.com/dpschen/kirby-plyrtag)
-
-Created and maintained by Dominik Pschenitschni ([@dpschen](https://github.com/dpschen))
-
-## Using package managers
-
-You can grab the source using one of the following package managers.
-
-### npm
-
-```
-npm install plyr
-```
-
-[https://www.npmjs.com/package/plyr](https://www.npmjs.com/package/plyr)
+| Type | Maintainer | Link |
+| --------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| WordPress | Ryan Anthony Drake ([@iamryandrake](https://github.com/iamryandrake)) | [https://wordpress.org/plugins/plyr/](https://wordpress.org/plugins/plyr/) |
+| React | Jose Miguel Bejarano ([@xDae](https://github.com/xDae)) | [https://github.com/xDae/react-plyr](https://github.com/xDae/react-plyr) |
+| Vue | Gabe Dunn ([@redxtech](https://github.com/redxtech)) | [https://github.com/redxtech/vue-plyr](https://github.com/redxtech/vue-plyr) |
+| Neos | Jon Uhlmann ([@jonnitto](https://github.com/jonnitto)) | [https://packagist.org/packages/jonnitto/plyr](https://packagist.org/packages/jonnitto/plyr) |
+| Kirby | Dominik Pschenitschni ([@dpschen](https://github.com/dpschen)) | [https://github.com/dpschen/kirby-plyrtag](https://github.com/dpschen/kirby-plyrtag) |
## Quick setup
-Here's a quick run through on getting up and running. There's also a [demo on Codepen](http://codepen.io/sampotts/pen/jARJYp).
+Here's a quick run through on getting up and running. There's also a [demo on Codepen](http://codepen.io/sampotts/pen/jARJYp). You can grab all of the source with [NPM](https://www.npmjs.com/package/plyr) using `npm install plyr`.
### HTML
@@ -142,7 +128,7 @@ Include the `plyr.js` script before the closing `</body>` tag and then call `ply
If you want to use our CDN (provided by [Fastly](https://www.fastly.com/)) for the JavaScript, you can use the following:
```html
-<script src="https://cdn.plyr.io/3.0.0-beta.12/plyr.js"></script>
+<script src="https://cdn.plyr.io/3.0.0-beta.13/plyr.js"></script>
```
_Note_: Be sure to read the [polyfills](#polyfills) section below about browser compatibility
@@ -158,13 +144,13 @@ Include the `plyr.css` stylsheet into your `<head>`
If you want to use our CDN (provided by [Fastly](https://www.fastly.com/)) for the default CSS, you can use the following:
```html
-<link rel="stylesheet" href="https://cdn.plyr.io/3.0.0-beta.12/plyr.css">
+<link rel="stylesheet" href="https://cdn.plyr.io/3.0.0-beta.13/plyr.css">
```
### SVG Sprite
The SVG sprite is loaded automatically from our CDN (provided by [Fastly](https://www.fastly.com/)). To change this, see the [options](#options) below. For
-reference, the CDN hosted SVG sprite can be found at `https://cdn.plyr.io/3.0.0-beta.12/plyr.svg`.
+reference, the CDN hosted SVG sprite can be found at `https://cdn.plyr.io/3.0.0-beta.13/plyr.svg`.
## Advanced
@@ -257,40 +243,40 @@ Options can be passed as an object to the constructor as above or as JSON in `da
Note the single quotes encapsulating the JSON and double quotes on the object keys. Only string values need double quotes.
-| Option | Type | Default | Description |
-| -------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `enabled` | Boolean | `true` | Completely disable Plyr. This would allow you to do a User Agent check or similar to programmatically enable or disable Plyr for a certain UA. Example below. |
-| `debug` | Boolean | `false` | Display debugging information in the console |
-| `controls` | Function or Array | `['play-large', 'play', 'progress', 'current-time', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'fullscreen']` | If a function is passed, it is assumed your method will return a string of HTML for the controls. Three arguments will be passed to your function; id (the unique id for the player), seektime (the seektime step in seconds), and title (the media title). See [controls.md](controls.md) for more info on how the html needs to be structured. |
-| `settings` | Array | `['captions', 'quality', 'speed', 'loop']` | If you're using the default controls are used then you can specify which settings to show in the menu |
-| `i18n` | Object | See [defaults.js](/src/js/defaults.js) | Used for internationalization (i18n) of the text within the UI. |
-| `loadSprite` | Boolean | `true` | Load the SVG sprite specified as the `iconUrl` option (if a URL). If `false`, it is assumed you are handling sprite loading yourself. |
-| `iconUrl` | String | `null` | Specify a URL or path to the SVG sprite. See the [SVG section](#svg) for more info. |
-| `iconPrefix` | String | `plyr` | Specify the id prefix for the icons used in the default controls (e.g. "plyr-play" would be "plyr"). This is to prevent clashes if you're using your own SVG sprite but with the default controls. Most people can ignore this option. |
-| `blankUrl` | String | `https://cdn.plyr.io/static/blank.mp4` | Specify a URL or path to a blank video file used to properly cancel network requests. |
-| `autoplay` | Boolean | `false` | Autoplay the media on load. This is generally advised against on UX grounds. It is also disabled by default in some browsers. If the `autoplay` attribute is present on a `<video>` or `<audio>` element, this will be automatically set to true. |
-| `autopause`&sup1; | Boolean | `true` | Only allow one player playing at once. |
-| `seekTime` | Number | `10` | The time, in seconds, to seek when a user hits fast forward or rewind. |
-| `volume` | Number | `1` | A number, between 0 and 1, representing the initial volume of the player. |
-| `muted` | Boolean | `false` | Whether to start playback muted. If the `muted` attribute is present on a `<video>` or `<audio>` element, this will be automatically set to true. |
-| `clickToPlay` | Boolean | `true` | Click (or tap) of the video container will toggle play/pause. |
-| `disableContextMenu` | Boolean | `true` | Disable right click menu on video to <em>help</em> as very primitive obfuscation to prevent downloads of content. |
-| `hideControls` | Boolean | `true` | Hide video controls automatically after 2s of no mouse or focus movement, on control element blur (tab out), on playback start or entering fullscreen. As soon as the mouse is moved, a control element is focused or playback is paused, the controls reappear instantly. |
-| `showPosterOnEnd` | Boolean | false | This will restore and _reload_ HTML5 video once playback is complete. Note: depending on the browser caching, this may result in the video downloading again (or parts of it). Use with caution. |
-| `keyboard` | Object | `{ focused: true, global: false }` | Enable [keyboard shortcuts](#shortcuts) for focused players only or globally |
-| `tooltips` | Object | `{ controls: false, seek: true }` | `controls`: Display control labels as tooltips on `:hover` & `:focus` (by default, the labels are screen reader only). `seek`: Display a seek tooltip to indicate on click where the media would seek to. |
-| `duration` | Number | `null` | Specify a custom duration for media. |
-| `displayDuration` | Boolean | `true` | Displays the duration of the media on the "metadataloaded" event (on startup) in the current time display. This will only work if the `preload` attribute is not set to `none` (or is not set at all) and you choose not to display the duration (see `controls` option). |
-| `invertTime` | Boolean | `true` | Display the current time as a countdown rather than an incremental counter. |
-| `toggleInvert` | Boolean | `true` | Allow users to click to toggle the above. |
-| `listeners` | Object | `null` | Allows binding of event listeners to the controls before the default handlers. See the `defaults.js` for available listeners. If your handler prevents default on the event (`event.preventDefault()`), the default handler will not fire. |
-| `captions` | Object | `{ active: false, language: window.navigator.language.split('-')[0] }` | `active`: Toggles if captions should be active by default. `language`: Sets the default language to load (if available). |
-| `fullscreen` | Object | `{ enabled: true, fallback: true }` | `enabled`: Toggles whether fullscreen should be enabled. `fallback`: Allow fallback to a full-window solution. |
-| `ratio` | String | `16:9` | The aspect ratio you want to use for embedded players. |
-| `storage` | Object | `{ enabled: true, key: 'plyr' }` | `enabled`: Allow use of local storage to store user settings. `key`: The key name to use. |
-| `speed` | Object | `{ selected: 1, options: [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2] }` | `selected`: The default speed for playback. `options`: Options to display in the menu. Most browsers will refuse to play slower than 0.5. |
-| `quality` | Object | `{ default: 'default', options: ['hd2160', 'hd1440', 'hd1080', 'hd720', 'large', 'medium', 'small', 'tiny', 'default'] }` | Currently only supported by YouTube. `default` is the default quality level, determined by YouTube. `options` are the options to display. |
-| `loop` | Object | `{ active: false }` | `active`: Whether to loop the current video. If the `loop` attribute is present on a `<video>` or `<audio>` element, this will be automatically set to true This is an object to support future functionality. |
+| Option | Type | Default | Description |
+| -------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `enabled` | Boolean | `true` | Completely disable Plyr. This would allow you to do a User Agent check or similar to programmatically enable or disable Plyr for a certain UA. Example below. |
+| `debug` | Boolean | `false` | Display debugging information in the console |
+| `controls` | Array, Function or Element | `['play-large', 'play', 'progress', 'current-time', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'fullscreen']` | If a function is passed, it is assumed your method will return either an element or HTML string for the controls. Three arguments will be passed to your function; `id` (the unique id for the player), `seektime` (the seektime step in seconds), and `title` (the media title). See [controls.md](controls.md) for more info on how the html needs to be structured. |
+| `settings` | Array | `['captions', 'quality', 'speed', 'loop']` | If you're using the default controls are used then you can specify which settings to show in the menu |
+| `i18n` | Object | See [defaults.js](/src/js/defaults.js) | Used for internationalization (i18n) of the text within the UI. |
+| `loadSprite` | Boolean | `true` | Load the SVG sprite specified as the `iconUrl` option (if a URL). If `false`, it is assumed you are handling sprite loading yourself. |
+| `iconUrl` | String | `null` | Specify a URL or path to the SVG sprite. See the [SVG section](#svg) for more info. |
+| `iconPrefix` | String | `plyr` | Specify the id prefix for the icons used in the default controls (e.g. "plyr-play" would be "plyr"). This is to prevent clashes if you're using your own SVG sprite but with the default controls. Most people can ignore this option. |
+| `blankUrl` | String | `https://cdn.plyr.io/static/blank.mp4` | Specify a URL or path to a blank video file used to properly cancel network requests. |
+| `autoplay` | Boolean | `false` | Autoplay the media on load. This is generally advised against on UX grounds. It is also disabled by default in some browsers. If the `autoplay` attribute is present on a `<video>` or `<audio>` element, this will be automatically set to true. |
+| `autopause`&sup1; | Boolean | `true` | Only allow one player playing at once. |
+| `seekTime` | Number | `10` | The time, in seconds, to seek when a user hits fast forward or rewind. |
+| `volume` | Number | `1` | A number, between 0 and 1, representing the initial volume of the player. |
+| `muted` | Boolean | `false` | Whether to start playback muted. If the `muted` attribute is present on a `<video>` or `<audio>` element, this will be automatically set to true. |
+| `clickToPlay` | Boolean | `true` | Click (or tap) of the video container will toggle play/pause. |
+| `disableContextMenu` | Boolean | `true` | Disable right click menu on video to <em>help</em> as very primitive obfuscation to prevent downloads of content. |
+| `hideControls` | Boolean | `true` | Hide video controls automatically after 2s of no mouse or focus movement, on control element blur (tab out), on playback start or entering fullscreen. As soon as the mouse is moved, a control element is focused or playback is paused, the controls reappear instantly. |
+| `showPosterOnEnd` | Boolean | false | This will restore and _reload_ HTML5 video once playback is complete. Note: depending on the browser caching, this may result in the video downloading again (or parts of it). Use with caution. |
+| `keyboard` | Object | `{ focused: true, global: false }` | Enable [keyboard shortcuts](#shortcuts) for focused players only or globally |
+| `tooltips` | Object | `{ controls: false, seek: true }` | `controls`: Display control labels as tooltips on `:hover` & `:focus` (by default, the labels are screen reader only). `seek`: Display a seek tooltip to indicate on click where the media would seek to. |
+| `duration` | Number | `null` | Specify a custom duration for media. |
+| `displayDuration` | Boolean | `true` | Displays the duration of the media on the "metadataloaded" event (on startup) in the current time display. This will only work if the `preload` attribute is not set to `none` (or is not set at all) and you choose not to display the duration (see `controls` option). |
+| `invertTime` | Boolean | `true` | Display the current time as a countdown rather than an incremental counter. |
+| `toggleInvert` | Boolean | `true` | Allow users to click to toggle the above. |
+| `listeners` | Object | `null` | Allows binding of event listeners to the controls before the default handlers. See the `defaults.js` for available listeners. If your handler prevents default on the event (`event.preventDefault()`), the default handler will not fire. |
+| `captions` | Object | `{ active: false, language: window.navigator.language.split('-')[0] }` | `active`: Toggles if captions should be active by default. `language`: Sets the default language to load (if available). |
+| `fullscreen` | Object | `{ enabled: true, fallback: true }` | `enabled`: Toggles whether fullscreen should be enabled. `fallback`: Allow fallback to a full-window solution. |
+| `ratio` | String | `16:9` | The aspect ratio you want to use for embedded players. |
+| `storage` | Object | `{ enabled: true, key: 'plyr' }` | `enabled`: Allow use of local storage to store user settings. `key`: The key name to use. |
+| `speed` | Object | `{ selected: 1, options: [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2] }` | `selected`: The default speed for playback. `options`: Options to display in the menu. Most browsers will refuse to play slower than 0.5. |
+| `quality` | Object | `{ default: 'default', options: ['hd2160', 'hd1440', 'hd1080', 'hd720', 'large', 'medium', 'small', 'tiny', 'default'] }` | Currently only supported by YouTube. `default` is the default quality level, determined by YouTube. `options` are the options to display. |
+| `loop` | Object | `{ active: false }` | `active`: Whether to loop the current video. If the `loop` attribute is present on a `<video>` or `<audio>` element, this will be automatically set to true This is an object to support future functionality. |
1. Vimeo only
@@ -318,69 +304,77 @@ element.addEventListener('ready', event => {
### Methods
-Methods are not chainable. An example use of a method:
+Example method use:
```javascript
-player.play();
+player.play(); // Start playback
+player.fullscreen.enter(); // Enter fullscreen
```
-| Method | Parameters | Description |
-| ------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- |
-| `play()`&sup1; | - | Start playback. |
-| `pause()` | - | Pause playback. |
-| `togglePlay(toggle)` | Boolean | Toggle playback, if no parameters are passed, it will toggle based on current status. |
-| `stop()` | - | Stop playback and reset to start. |
-| `restart()` | - | Restart playback. |
-| `rewind(seekTime)` | Number | Rewind playback by the specified seek time. If no parameter is passed, the default seek time will be used. |
-| `forward(seekTime)` | Number | Fast forward by the specified seek time. If no parameter is passed, the default seek time will be used. |
-| `increaseVolume(step)` | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. |
-| `decreaseVolume(step)` | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. |
-| `toggleCaptions(toggle)` | Boolean | Toggle captions display. If no parameter is passed, it will toggle based on current status. |
-| `toggleFullscreen(event)` | Event | Toggle fullscreen. Fullscreen can only be initiated by a user event. Exit is possible without user input. |
-| `airplay()` | - | Trigger the airplay dialog on supported devices. |
-| `toggleControls(toggle)` | Boolean | Toggle the controls based on the specified boolean. |
-| `on(event, function)` | String, Function | Add an event listener for the specified event. |
-| `off(event, function)` | String, Function | Remove an event listener for the specified event. |
-| `supports(type)` | String | Check support for a mime type. |
-| `destroy()` | - | Destroy the instance and garbage collect any elements. |
+| Method | Parameters | Description |
+| ------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------- |
+| `play()`&sup1; | - | Start playback. |
+| `pause()` | - | Pause playback. |
+| `togglePlay(toggle)` | Boolean | Toggle playback, if no parameters are passed, it will toggle based on current status. |
+| `stop()` | - | Stop playback and reset to start. |
+| `restart()` | - | Restart playback. |
+| `rewind(seekTime)` | Number | Rewind playback by the specified seek time. If no parameter is passed, the default seek time will be used. |
+| `forward(seekTime)` | Number | Fast forward by the specified seek time. If no parameter is passed, the default seek time will be used. |
+| `increaseVolume(step)` | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. |
+| `decreaseVolume(step)` | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. |
+| `toggleCaptions(toggle)` | Boolean | Toggle captions display. If no parameter is passed, it will toggle based on current status. |
+| `fullscreen.enter()` | - | Enter fullscreen. If fullscreen is not supported, a fallback "full window/viewport" is used instead. |
+| `fullscreen.exit()` | - | Exit fullscreen. |
+| `fullscreen.toggle()` | - | Toggle fullscreen. |
+| `airplay()` | - | Trigger the airplay dialog on supported devices. |
+| `toggleControls(toggle)` | Boolean | Toggle the controls based on the specified boolean. |
+| `on(event, function)` | String, Function | Add an event listener for the specified event. |
+| `off(event, function)` | String, Function | Remove an event listener for the specified event. |
+| `supports(type)` | String | Check support for a mime type. |
+| `destroy()` | - | Destroy the instance and garbage collect any elements. |
1. For HTML5 players, `play()` will return a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) in _some_ browsers - WebKit and Mozilla [according to MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/play) at time of writing.
### Getters and Setters
-An example setter:
+Example setters:
```javascript
-player.volume = 0.5;
+player.volume = 0.5; // Sets volume at 50%
+player.currentTime = 10; // Seeks to 10 seconds
```
-An example getter:
+Example getters:
```javascript
-player.volume; // returns 0.5;
+player.volume; // 0.5;
+player.currentTime; // 10
+player.fullscreen.active; // false;
```
-| Property | Getter | Setter | Description |
-| --------------- | ------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `isHTML5` | ✔ | - | Returns a boolean indicating if the current player is HTML5. |
-| `isEmbed` | ✔ | - | Returns a boolean indicating if the current player is an embedded player. |
-| `paused` | ✔ | - | Returns a boolean indicating if the current player is paused. |
-| `playing` | ✔ | - | Returns a boolean indicating if the current player is playing. |
-| `ended` | ✔ | - | Returns a boolean indicating if the current player has finished playback. |
-| `currentTime` | ✔ | ✔ | Gets or sets the currentTime for the player. The setter accepts a float in seconds. |
-| `seeking` | ✔ | - | Returns a boolean indicating if the current player is seeking. |
-| `duration` | ✔ | - | Returns the duration for the current media. |
-| `volume` | ✔ | ✔ | Gets or sets the volume for the player. The setter accepts a float between 0 and 1. |
-| `muted` | ✔ | ✔ | Gets or sets the muted state of the player. The setter accepts a boolean. |
-| `hasAudio` | ✔ | - | Returns a boolean indicating if the current media has an audio track. |
-| `speed` | ✔ | ✔ | Gets or sets the speed for the player. The setter accepts a value in the options specified in your config. Generally the minimum should be 0.5. |
-| `quality`&sup1; | ✔ | ✔ | Gets or sets the quality for the player. The setter accepts a value from the options specified in your config. |
-| `loop` | ✔ | ✔ | Gets or sets the current loop state of the player. The setter accepts a boolean. |
-| `source` | ✔ | ✔ | Gets or sets the current source for the player. The setter accepts an object. See [source setter](#source-setter) below for examples. |
-| `poster`&sup2; | ✔ | ✔ | Gets or sets the current poster image for the player. The setter accepts a string; the URL for the updated poster image. |
-| `autoplay` | ✔ | ✔ | Gets or sets the autoplay state of the player. The setter accepts a boolean. |
-| `language` | ✔ | ✔ | Gets or sets the preferred captions language for the player. The setter accepts an ISO two-letter language code. Support for the languages is dependent on the captions you include. |
-| `pip` | ✔ | ✔ | Gets or sets the picture-in-picture state of the player. The setter accepts a boolean. This currently only supported on Safari 10+ on MacOS Sierra+ and iOS 10+. |
+| Property | Getter | Setter | Description |
+| -------------------- | ------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `isHTML5` | ✓ | - | Returns a boolean indicating if the current player is HTML5. |
+| `isEmbed` | ✓ | - | Returns a boolean indicating if the current player is an embedded player. |
+| `paused` | ✓ | - | Returns a boolean indicating if the current player is paused. |
+| `playing` | ✓ | - | Returns a boolean indicating if the current player is playing. |
+| `ended` | ✓ | - | Returns a boolean indicating if the current player has finished playback. |
+| `currentTime` | ✓ | ✓ | Gets or sets the currentTime for the player. The setter accepts a float in seconds. |
+| `seeking` | ✓ | - | Returns a boolean indicating if the current player is seeking. |
+| `duration` | ✓ | - | Returns the duration for the current media. |
+| `volume` | ✓ | ✓ | Gets or sets the volume for the player. The setter accepts a float between 0 and 1. |
+| `muted` | ✓ | ✓ | Gets or sets the muted state of the player. The setter accepts a boolean. |
+| `hasAudio` | ✓ | - | Returns a boolean indicating if the current media has an audio track. |
+| `speed` | ✓ | ✓ | Gets or sets the speed for the player. The setter accepts a value in the options specified in your config. Generally the minimum should be 0.5. |
+| `quality`&sup1; | ✓ | ✓ | Gets or sets the quality for the player. The setter accepts a value from the options specified in your config. |
+| `loop` | ✓ | ✓ | Gets or sets the current loop state of the player. The setter accepts a boolean. |
+| `source` | ✓ | ✓ | Gets or sets the current source for the player. The setter accepts an object. See [source setter](#source-setter) below for examples. |
+| `poster`&sup2; | ✓ | ✓ | Gets or sets the current poster image for the player. The setter accepts a string; the URL for the updated poster image. |
+| `autoplay` | ✓ | ✓ | Gets or sets the autoplay state of the player. The setter accepts a boolean. |
+| `language` | ✓ | ✓ | Gets or sets the preferred captions language for the player. The setter accepts an ISO two-letter language code. Support for the languages is dependent on the captions you include. |
+| `fullscreen.active` | ✓ | - | Returns a boolean indicating if the current player is in fullscreen mode. |
+| `fullscreen.enabled` | ✓ | - | Returns a boolean indicating if the current player has fullscreen enabled. |
+| `pip` | ✓ | ✓ | Gets or sets the picture-in-picture state of the player. The setter accepts a boolean. This currently only supported on Safari 10+ on MacOS Sierra+ and iOS 10+. |
1. YouTube only. HTML5 will follow.
2. HTML5 only
@@ -596,14 +590,14 @@ Plyr supports the last 2 versions of most _modern_ browsers.
| Browser | Supported |
| ------------- | --------- |
-| Safari | ✔ |
-| Mobile Safari | ✔&sup1; |
-| Firefox | ✔ |
-| Chrome | ✔ |
-| Opera | ✔ |
-| Edge | ✔ |
-| IE11 | ✔ |
-| IE10 | ✔&sup2; |
+| Safari | ✓ |
+| Mobile Safari | ✓&sup1; |
+| Firefox | ✓ |
+| Chrome | ✓ |
+| Opera | ✓ |
+| Edge | ✓ |
+| IE11 | ✓ |
+| IE10 | ✓&sup2; |
1. Mobile Safari on the iPhone forces the native player for `<video>` unless the `playsinline` attribute is present. Volume controls are also disabled as they are handled device wide.
2. Native player used (no support for `<progress>` or `<input type="range">`) but the API is supported. No native fullscreen support, fallback can be used (see [options](#options))