mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-25 08:01:20 -08:00
update docs
This commit is contained in:
Harvey Zack committed
1 parent
9fe5c5d021
commit
992dab34ae
10 files changed
+283
-64
No files matched your search
@@ -56,9 +56,225 @@ Note: You need to initialize a size for the container element, like:
|
||||
```
|
||||
|
||||
## Configuration
|
||||
<table>
|
||||
<tr>
|
||||
<th>parameter</th>
|
||||
<th>description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>container</code></th>
|
||||
<td>
|
||||
Type: <code>string</code>, <code>element</code><br>
|
||||
Default: <code>.artplayer</code><br>
|
||||
Required: <code>true</code><br><br>
|
||||
DOM container of the player
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>url</code></th>
|
||||
<td>
|
||||
Type: <code>string</code><br>
|
||||
Default: <code>''</code><br>
|
||||
Required: <code>true</code><br><br>
|
||||
Video source url
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>poster</code></th>
|
||||
<td>
|
||||
Type: <code>string</code><br>
|
||||
Default: <code>''</code><br><br>
|
||||
Video poster url
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>title</code></th>
|
||||
<td>
|
||||
Type: <code>string</code><br>
|
||||
Default: <code>''</code><br><br>
|
||||
Video title, will be shown in screenshot file name and pip mode
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>volume</code></th>
|
||||
<td>
|
||||
Type: <code>number</code><br>
|
||||
Default: <code>0.7</code><br><br>
|
||||
Default volume, player will cache the last volume, which may be overwritten
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>autoplay</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to play automatically, sometimes it doesn't necessarily succeed<br>
|
||||
More info: <a href="https://developers.google.com/web/updates/2017/09/autoplay-policy-changes">autoplay-policy-changes</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>autoSize</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Keep the original video aspect ratio and automatically zoom
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>loop</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Automatic loop playback
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>playbackRate</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show playback rate controller in the contextmenu
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>aspectRatio</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show aspect ratio controller in the contextmenu
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>screenshot</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show screenshot controller in the bottom
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>setting</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show setting controller in the bottom
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>pip</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show pip controller in the bottom
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>fullscreen</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show window fullscreen controller in the bottom
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>fullscreenWeb</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>false</code><br><br>
|
||||
Whether to show web page fullscreen controller in the bottom
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>hotkey</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>true</code><br><br>
|
||||
Whether to use hotkey
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>lang</code></th>
|
||||
<td>
|
||||
Type: <code>string</code><br>
|
||||
Default: <code>navigator.language.toLowerCase()</code><br><br>
|
||||
Default display language
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>theme</code></th>
|
||||
<td>
|
||||
Type: <code>string</code><br>
|
||||
Default: <code>#f00</code><br><br>
|
||||
Default theme color
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>mutex</code></th>
|
||||
<td>
|
||||
Type: <code>boolean</code><br>
|
||||
Default: <code>true</code><br><br>
|
||||
Player mutually exclusive
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>layers</code></th>
|
||||
<td>
|
||||
Type: <code>array</code><br>
|
||||
Default: <code>[]</code><br><br>
|
||||
Custom layer, The type of layer is an object<br>
|
||||
<table>
|
||||
<tr>
|
||||
<th><code>name</code></th>
|
||||
<td>
|
||||
Type: <code>string</code><br>
|
||||
Default: <code>layer${id}</code><br><br>
|
||||
The unique name of the layer, used for the class name
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>index</code></th>
|
||||
<td>
|
||||
Type: <code>number</code><br>
|
||||
Default: <code>${id}</code><br><br>
|
||||
The unique index of the layer, used for the priority level
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>html</code></th>
|
||||
<td>
|
||||
Type: <code>string</code>, <code>element</code><br>
|
||||
Default: <code>''</code><br><br>
|
||||
The dom element of the layer
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>style</code></th>
|
||||
<td>
|
||||
Type: <code>object</code><br>
|
||||
Default: <code>{}</code><br><br>
|
||||
The style object of the layer
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><code>click</code></th>
|
||||
<td>
|
||||
Type: <code>function</code><br>
|
||||
Default: <code>undefined</code><br><br>
|
||||
Click event of the layer
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## API
|
||||
|
||||
## Ecosystem
|
||||
| Project | Description |
|
||||
|---------|--------|
|
||||
| [artplayer-plugin-danmu](https://github.com/zhw2590582/ArtPlayer/tree/master/packages/artplayer-plugin-danmu) | Danmu plugin for ArtPlayer |
|
||||
|
||||
## Issue
|
||||
|
||||
## Contributors
|
||||
|
||||
Reference in new issue
Block a user