mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-20 04:01:20 -08:00
Harvey Zhao
92f09a4290
- Updated descriptions and terminology across various component documentation files for improved clarity. - Changed headings and section titles for better readability and consistency. - Enhanced the language and structure of the documentation to provide clearer guidance on usage and configuration. - Removed the `fix-docs.js` script as its functionality has been integrated into the translation process. - Improved the translation script to handle Markdown code block issues and added retry logic for API calls.
136 lines
2.3 KiB
Markdown
136 lines
2.3 KiB
Markdown
# Static Properties
|
|
|
|
Here, `static properties` refer to the `first-level properties` attached to the `constructor`, which are rarely used.
|
|
|
|
## `instances`
|
|
|
|
Returns an array of all player instances. This property can be useful when you need to manage multiple players simultaneously.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info([...Artplayer.instances]);
|
|
|
|
var art = new Artplayer({
|
|
container: '.artplayer-app',
|
|
url: '/assets/sample/video.mp4',
|
|
});
|
|
|
|
console.info([...Artplayer.instances]);
|
|
```
|
|
|
|
## `version`
|
|
|
|
Returns the version information of the player.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.version);
|
|
```
|
|
|
|
## `env`
|
|
|
|
Returns the environment variables of the player.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.env);
|
|
```
|
|
|
|
## `build`
|
|
|
|
Returns the build timestamp of the player.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.build);
|
|
```
|
|
|
|
## `config`
|
|
|
|
Returns the default configuration for videos.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.config);
|
|
```
|
|
|
|
## `utils`
|
|
|
|
Returns the collection of utility functions for the player.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.utils);
|
|
```
|
|
|
|
:::warning For all utility functions, please refer to the following address:
|
|
|
|
[artplayer/types/utils.d.ts](https://github.com/zhw2590582/ArtPlayer/blob/master/packages/artplayer/types/utils.d.ts)
|
|
|
|
:::
|
|
|
|
## `scheme`
|
|
|
|
Returns the validation schema for player options.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.scheme);
|
|
```
|
|
|
|
## `Emitter`
|
|
|
|
Returns the constructor of the event emitter.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.Emitter);
|
|
```
|
|
|
|
## `validator`
|
|
|
|
Returns the validation function for options.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.validator);
|
|
```
|
|
|
|
## `kindOf`
|
|
|
|
Returns the type detection utility function.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.kindOf);
|
|
```
|
|
|
|
## `html`
|
|
|
|
Returns the `html` string required by the player.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.html);
|
|
```
|
|
|
|
## `option`
|
|
|
|
Returns the default options of the player.
|
|
|
|
<div className="run-code">▶ Run Code</div>
|
|
|
|
```js
|
|
console.info(Artplayer.option);
|
|
``` |