From 9c5aa6424b416b34043ac8d3fdceeb83d44f2e22 Mon Sep 17 00:00:00 2001 From: Harvey Date: Fri, 26 Nov 2021 18:20:07 +0800 Subject: [PATCH] update --- .../artplayer-document/docs/zh-cn/Class.md | 132 +++++++++++++++++- .../artplayer-document/docs/zh-cn/Events.md | 2 +- .../docs/zh-cn/Properties.md | 2 +- 3 files changed, 133 insertions(+), 3 deletions(-) diff --git a/packages/artplayer-document/docs/zh-cn/Class.md b/packages/artplayer-document/docs/zh-cn/Class.md index 2b737b860..0aa047f40 100644 --- a/packages/artplayer-document/docs/zh-cn/Class.md +++ b/packages/artplayer-document/docs/zh-cn/Class.md @@ -1,5 +1,135 @@ --- title: 静态属性 -sidebar_position: 6 +sidebar_position: 5 slug: /zh-cn/class --- + +:::tip 提示 + +静态属性存在于构造函数 `Artplayer` 上,和播放器实例没有直接关联 + +::: + +## instances + +- 类型: `Array` + +一个保存了所有播放器实例的数组,当单个页面同时存在多个播放器时,可以通过这个属性进行管理 + +
▶ Run Code
+ +```js +var art = new Artplayer({ + container: '.artplayer-app', + url: '/assets/sample/video.mp4', +}); + +art.on('ready', () => { + console.info(Artplayer.instances.length) +}) +``` + +## version + +- 类型: `String` + +当前播放器版本号 + +
▶ Run Code
+ +```js +console.info(Artplayer.version) +``` + +## env + +- 类型: `String` + +当前播放器环境变量 + +
▶ Run Code
+ +```js +console.info(Artplayer.env) +``` + +## utils + +- 类型: `Object` + +播放器的常用工具集 + +
▶ Run Code
+ +```js +console.info(Object.keys(Artplayer.utils)) +``` + +## config + +- 类型: `Object` + +存放了播放器的原生属性和方法 + +
▶ Run Code
+ +```js +console.info(Artplayer.config) +``` + +## scheme + +- 类型: `Object` + +播放器参数的校验方案 + +
▶ Run Code
+ +```js +console.info(Artplayer.scheme) +``` + +## validator + +- 类型: `Function` + +播放器参数的校验器 + +## option + +- 类型: `Object` + +播放器默认参数 + +
▶ Run Code
+ +```js +console.info(Artplayer.option) +``` + +## html + +- 类型: `String` + +播放器默认 `Html` 字符串,通常用于 `SSR` 的提前渲染,更多信息请访问 [配合SSR使用](/document/zh-cn/Questions/ssr) + +
▶ Run Code
+ +```js +console.info(Artplayer.html) +``` + +## kindOf + +- 类型: `Function` + +JS类型识别函数 + +
▶ Run Code
+ +```js +console.info(Artplayer.kindOf('0')) +console.info(Artplayer.kindOf(0)) +console.info(Artplayer.kindOf({})) +console.info(Artplayer.kindOf([])) +``` \ No newline at end of file diff --git a/packages/artplayer-document/docs/zh-cn/Events.md b/packages/artplayer-document/docs/zh-cn/Events.md index 6cc4c18c9..996310bff 100644 --- a/packages/artplayer-document/docs/zh-cn/Events.md +++ b/packages/artplayer-document/docs/zh-cn/Events.md @@ -1,5 +1,5 @@ --- title: 实例事件 -sidebar_position: 5 +sidebar_position: 6 slug: /zh-cn/events --- diff --git a/packages/artplayer-document/docs/zh-cn/Properties.md b/packages/artplayer-document/docs/zh-cn/Properties.md index 2b4ea043e..0ca391a2c 100644 --- a/packages/artplayer-document/docs/zh-cn/Properties.md +++ b/packages/artplayer-document/docs/zh-cn/Properties.md @@ -499,7 +499,7 @@ art.on('ready', () => { - 类型: `Getter` - 参数: `Boolean` -设置视频是否正在播放中 +获取视频是否正在播放中
▶ Run Code