Files
ArtPlayer/packages/artplayer-document/docs/en/Plugins/control.mdx
T
2023-01-01 00:30:01 +08:00

89 lines
1.8 KiB
Plaintext

---
title: Control Plugin
sidebar_position: 5
---
## Demo
👉 [View Demo](https://artplayer.org/?libs=./uncompiled/artplayer-plugin-control/index.js&example=control)
## Install
### Install from `npm`:
```bash
$ npm install artplayer-plugin-control
```
### Install from `yarn`:
```bash
$ yarn add artplayer-plugin-control
```
### Install from `script`:
```html
<!-- local -->
<script src="path/to/artplayer-plugin-control.js"></script>
<!-- jsdelivr -->
<script src="https://cdn.jsdelivr.net/npm/artplayer-plugin-control/dist/artplayer-plugin-control.js"></script>
<!-- unpkg -->
<script src="https://unpkg.com/artplayer-plugin-control/dist/artplayer-plugin-control.js"></script>
```
Then you can access the plugin function through `window.artplayerPluginControl`
## Use
<div className="run-code" data-libs="./uncompiled/artplayer-plugin-control/index.js">
▶ Run Code
</div>
```js
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
fullscreen: true,
fullscreenWeb: true,
plugins: [
artplayerPluginControl(),
],
});
```
## Api
### enable
- Type: `Getter/Setter`
Whether to enable the new control UI
<div className="run-code" data-libs="./uncompiled/artplayer-plugin-control/index.js">
▶ Run Code
</div>
```js
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
fullscreen: true,
fullscreenWeb: true,
controls: [
{
position: 'right',
html: '<button type="button">Switcher UI</button>',
click: function () {
const { enable } = art.plugins.artplayerPluginControl;
art.plugins.artplayerPluginControl.enable = !enable;
},
},
],
plugins: [
artplayerPluginControl(),
],
});
``