`js
const players = Array.from(document.querySelectorAll('.js-player')).map((p) => new Plyr(p));
`

...or use a static method where you can pass a CSS string selector, a NodeList, an Array of HTMLElement, or a JQuery object:

`js
const players = Plyr.setup('.js-player');
`

Both options will also return an array of instances in the order of they were in the DOM for the string selector or the source NodeList or Array.

#### Options

The second argument for the constructor is the options object:

`js
const player = new Plyr('#player', {
title: 'Example Title',
});
`

Options can be passed as an object to the constructor as above or as JSON in data-plyr-config attribute on each of your target elements:

`html

`

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 | 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 for more info on how the html needs to be structured. |
| settings | Array | ['captions', 'quality', 'speed', 'loop'] | If the default controls are used, you can specify which settings to show in the menu |
| i18n | Object | See 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 | https://cdn.plyr.io/3.8.4/plyr.svg | Specify a URL or path to the SVG sprite. See the SVG section 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. |
| blankVideo | 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. If the autoplay attribute is present on a

1. Vimeo only
2. Autoplay is generally not recommended as it is seen as a negative user experience. It is also disabled in many browsers. Before raising issues, do your homework. More info can be found here:

-
-
-

3. YouTube does not support programatically toggling the native fullscreen player via it's API. This means on iOS you have two options, neither being perfect:

- Use the fallback/faux fullscreen option which covers the whole viewport (this is the default)
- Set playsinline to false and/or fullscreen.iosNative to true - either option hides the fullscreen toggle in the UI (because of the above API issue) and means iOS will play the video in it's native player.

API

There are methods, setters and getters on a Plyr object.

Object

The easiest way to access the Plyr object is to set the return value from your call to the constructor to a variable. For example:

`js
const player = new Plyr('#player', {
/ options /
});
`

You can also access the object through any events:

`js
element.addEventListener('ready', (event) => {
const player = event.detail.plyr;
});
`

Methods

Example method use:

`js
player.play(); // Start playback
player.fullscreen.enter(); // Enter fullscreen
`

| Method | Parameters | Description |
| -------------------------------------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- |
| play()¹ | - | 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. |
| setPreviewThumbnails(source: PreviewThumbnailsOptions) | - | Sets the preview thumbnails for the current source. |
| toggleControls(toggle) | Boolean | Toggle the controls (video only). Takes optional truthy value to force it on/off. |
| on(event, function) | String, Function | Add an event listener for the specified event. |
| once(event, function) | String, Function | Add an event listener for the specified event once. |
| 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 for most browsers - e.g. Chrome, Firefox, Opera, Safari and Edge according to MDN at time of writing.

Getters and Setters

Example setters:

`js
player.volume = 0.5; // Sets volume at 50%
player.currentTime = 10; // Seeks to 10 seconds
`

Example getters:

`js
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. |
| playing | ✓ | - | Returns a boolean indicating if the current player is playing. |
| paused | ✓ | - | Returns a boolean indicating if the current player is paused. |
| stopped | ✓ | - | Returns a boolean indicating if the current player is stopped. |
| ended | ✓ | - | Returns a boolean indicating if the current player has finished playback. |
| buffered | ✓ | - | Returns a float between 0 and 1 indicating how much of the media is buffered |
| 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 spec