update docs

This commit is contained in:
Harvey Zack committed 2023-02-24 21:29:55 +08:00
1 parent a3425da515
commit 9433cbc2bb
4 files changed
+282 -3

No files matched your search

-3
View File
@@ -60,8 +60,5 @@
"engines": { "engines": {
"node": ">= 16.0.0" "node": ">= 16.0.0"
}, },
"pre-commit": [
"prettier"
],
"__npminstall_done": false "__npminstall_done": false
} }
@@ -626,6 +626,143 @@ art.on('subtitleSwitch', (url) => {
}); });
``` ```
## `info`
当信息面板显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('info', (state) => {
console.log(state);
});
```
## `layer`
当自定义层显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('layer', (state) => {
console.log(state);
});
```
## `loading`
当加载器显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('loading', (state) => {
console.log(state);
});
```
## `mask`
当遮罩层显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('mask', (state) => {
console.log(state);
});
```
## `subtitle`
当字幕层显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('subtitle', (state) => {
console.log(state);
});
```
## `contextmenu`
当右键菜单显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('contextmenu', (state) => {
console.log(state);
});
```
## `control`
当控制器显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('control', (state) => {
console.log(state);
});
```
## `setting`
当设置面板显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
setting: true,
});
art.on('setting', (state) => {
console.log(state);
});
```
## `video:canplay` ## `video:canplay`
浏览器可以播放媒体文件了,但估计没有足够的数据来支撑播放到结束,不必停下来进一步缓冲内容 浏览器可以播放媒体文件了,但估计没有足够的数据来支撑播放到结束,不必停下来进一步缓冲内容
@@ -626,6 +626,143 @@ art.on('subtitleSwitch', (url) => {
}); });
``` ```
## `info`
当信息面板显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('info', (state) => {
console.log(state);
});
```
## `layer`
当自定义层显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('layer', (state) => {
console.log(state);
});
```
## `loading`
当加载器显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('loading', (state) => {
console.log(state);
});
```
## `mask`
当遮罩层显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('mask', (state) => {
console.log(state);
});
```
## `subtitle`
当字幕层显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('subtitle', (state) => {
console.log(state);
});
```
## `contextmenu`
当右键菜单显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('contextmenu', (state) => {
console.log(state);
});
```
## `control`
当控制器显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
});
art.on('control', (state) => {
console.log(state);
});
```
## `setting`
当设置面板显示或隐藏时触发
<div className="run-code">▶ Run Code</div>
```js{6}
var art = new Artplayer({
container: '.artplayer-app',
url: '/assets/sample/video.mp4',
setting: true,
});
art.on('setting', (state) => {
console.log(state);
});
```
## `video:canplay` ## `video:canplay`
浏览器可以播放媒体文件了,但估计没有足够的数据来支撑播放到结束,不必停下来进一步缓冲内容 浏览器可以播放媒体文件了,但估计没有足够的数据来支撑播放到结束,不必停下来进一步缓冲内容
+8
View File
@@ -23,6 +23,14 @@ export type Events = {
'video:timeupdate': [event: Event]; 'video:timeupdate': [event: Event];
'video:volumechange': [event: Event]; 'video:volumechange': [event: Event];
'video:waiting': [event: Event]; 'video:waiting': [event: Event];
info: [state: boolean];
layer: [state: boolean];
loading: [state: boolean];
mask: [state: boolean];
subtitle: [state: boolean];
contextmenu: [state: boolean];
control: [state: boolean];
setting: [state: boolean];
hotkey: [event: Event]; hotkey: [event: Event];
destroy: []; destroy: [];
url: [url: string]; url: [url: string];