@wapri/gplayer 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/VideoPlayer/index.d.ts +2 -2
- package/dist/VideoPlayer/index.vue.d.ts +2 -2
- package/dist/constant/effect.d.ts +106 -0
- package/dist/constant/filters.d.ts +15 -0
- package/dist/constant/icons.d.ts +20 -0
- package/dist/constant/index.d.ts +5 -1
- package/dist/core/cssFilter.d.ts +4 -0
- package/dist/core/effectMenu.d.ts +32 -0
- package/dist/core/frame.d.ts +8 -0
- package/dist/core/style.d.ts +5 -0
- package/dist/index.d.ts +7 -3
- package/dist/index.mjs +1120 -280
- package/dist/plugins/backgroundBlur.d.ts +3 -0
- package/dist/plugins/blur.d.ts +3 -0
- package/dist/plugins/chromaKey.d.ts +3 -0
- package/dist/plugins/index.d.ts +12 -1
- package/dist/plugins/intro.d.ts +3 -0
- package/dist/plugins/mosaic.d.ts +3 -0
- package/dist/plugins/overlay.d.ts +3 -0
- package/dist/plugins/reverse.d.ts +3 -0
- package/dist/plugins/stabilizer.d.ts +3 -0
- package/dist/plugins/vertical.d.ts +3 -0
- package/dist/plugins/videoFilter.d.ts +3 -0
- package/dist/plugins/webFullscreen.d.ts +3 -0
- package/dist/types/frame.d.ts +73 -0
- package/dist/types/plugin.d.ts +141 -0
- package/package.json +1 -1
package/dist/plugins/index.d.ts
CHANGED
|
@@ -1,12 +1,23 @@
|
|
|
1
1
|
import { abLoopPlugin } from './abLoop';
|
|
2
2
|
import { aspectRatioPlugin } from './aspectRatio';
|
|
3
|
+
import { backgroundBlurPlugin } from './backgroundBlur';
|
|
4
|
+
import { blurPlugin } from './blur';
|
|
5
|
+
import { chromaKeyPlugin } from './chromaKey';
|
|
3
6
|
import { filterPlugin } from './filter';
|
|
4
7
|
import { flipPlugin } from './flip';
|
|
8
|
+
import { introPlugin } from './intro';
|
|
9
|
+
import { mosaicPlugin } from './mosaic';
|
|
10
|
+
import { overlayPlugin } from './overlay';
|
|
5
11
|
import { pipPlugin } from './pip';
|
|
6
12
|
import { playbackRatePlugin } from './playbackRate';
|
|
13
|
+
import { reversePlugin } from './reverse';
|
|
7
14
|
import { screenshotPlugin } from './screenshot';
|
|
15
|
+
import { stabilizerPlugin } from './stabilizer';
|
|
16
|
+
import { verticalPlugin } from './vertical';
|
|
17
|
+
import { videoFilterPlugin } from './videoFilter';
|
|
18
|
+
import { webFullscreenPlugin } from './webFullscreen';
|
|
8
19
|
import { PluginDefinition } from '../types/plugin';
|
|
9
20
|
|
|
10
21
|
/** 内置插件,按右侧菜单的展示顺序排列 */
|
|
11
22
|
export declare const builtinPlugins: PluginDefinition[];
|
|
12
|
-
export { abLoopPlugin, aspectRatioPlugin, filterPlugin, flipPlugin, pipPlugin, playbackRatePlugin, screenshotPlugin };
|
|
23
|
+
export { abLoopPlugin, aspectRatioPlugin, backgroundBlurPlugin, blurPlugin, chromaKeyPlugin, filterPlugin, flipPlugin, introPlugin, mosaicPlugin, overlayPlugin, pipPlugin, playbackRatePlugin, reversePlugin, screenshotPlugin, stabilizerPlugin, verticalPlugin, videoFilterPlugin, webFullscreenPlugin, };
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/** 画面适配方式:`contain` 完整显示,`cover` 裁切铺满,`fill` 直接拉伸(与 artplayer 的 `object-fit: fill` 对齐) */
|
|
2
|
+
export type FrameFit = 'contain' | 'cover' | 'fill';
|
|
3
|
+
/** 视频滤镜预设 */
|
|
4
|
+
export type VideoFilterPreset = 'none' | 'mono' | 'sepia' | 'vivid' | 'warm' | 'cool' | 'fade' | 'film' | 'invert';
|
|
5
|
+
/** 马赛克:块越大越糊 */
|
|
6
|
+
export interface MosaicEffect {
|
|
7
|
+
/** 块的边长,单位为工作画布像素 */
|
|
8
|
+
size: number;
|
|
9
|
+
}
|
|
10
|
+
/** 整画面模糊 */
|
|
11
|
+
export interface BlurEffect {
|
|
12
|
+
/** 模糊半径(px) */
|
|
13
|
+
radius: number;
|
|
14
|
+
}
|
|
15
|
+
/** 背景模糊:前景保持比例居中,四周用同一帧放大模糊铺满 */
|
|
16
|
+
export interface BackgroundBlurEffect {
|
|
17
|
+
/** 背景模糊半径(px) */
|
|
18
|
+
radius: number;
|
|
19
|
+
/** 背景放大倍数,避免模糊后边缘透出黑边 */
|
|
20
|
+
overscan: number;
|
|
21
|
+
}
|
|
22
|
+
/** 绿幕抠像 */
|
|
23
|
+
export interface ChromaKeyEffect {
|
|
24
|
+
/** 被抠掉的颜色,`#rrggbb` */
|
|
25
|
+
color: string;
|
|
26
|
+
/** 相似度 0–1,越大抠得越干净,也越容易误伤主体 */
|
|
27
|
+
similarity: number;
|
|
28
|
+
/** 边缘羽化 0–1,越大过渡越柔和 */
|
|
29
|
+
smoothness: number;
|
|
30
|
+
}
|
|
31
|
+
/** 视频滤镜 */
|
|
32
|
+
export interface VideoFilterEffect {
|
|
33
|
+
preset: VideoFilterPreset;
|
|
34
|
+
/** 强度 0–1 */
|
|
35
|
+
intensity: number;
|
|
36
|
+
}
|
|
37
|
+
/** 横屏转竖屏 */
|
|
38
|
+
export interface VerticalEffect {
|
|
39
|
+
fit: FrameFit;
|
|
40
|
+
/** 顺时针旋转角度 */
|
|
41
|
+
rotate: 0 | 90;
|
|
42
|
+
}
|
|
43
|
+
/** 防抖:与上一帧做时间域混合,压掉手持抖动带来的高频闪烁 */
|
|
44
|
+
export interface StabilizerEffect {
|
|
45
|
+
/** 混合强度 0–1,越大越稳但残影越明显 */
|
|
46
|
+
strength: number;
|
|
47
|
+
}
|
|
48
|
+
/** 帧效果参数映射,插件按 key 写入自己那一份 */
|
|
49
|
+
export type FrameEffectMap = {
|
|
50
|
+
mosaic: MosaicEffect;
|
|
51
|
+
blur: BlurEffect;
|
|
52
|
+
backgroundBlur: BackgroundBlurEffect;
|
|
53
|
+
chromaKey: ChromaKeyEffect;
|
|
54
|
+
videoFilter: VideoFilterEffect;
|
|
55
|
+
vertical: VerticalEffect;
|
|
56
|
+
stabilizer: StabilizerEffect;
|
|
57
|
+
};
|
|
58
|
+
/** 帧效果的 key */
|
|
59
|
+
export type FrameEffectKey = keyof FrameEffectMap;
|
|
60
|
+
/** 帧渲染器:需要逐帧处理画面的插件通过它改画面 */
|
|
61
|
+
export interface FrameRenderer {
|
|
62
|
+
/** 设置一类效果,传 `null` 关闭 */
|
|
63
|
+
set<K extends FrameEffectKey>(key: K, effect: FrameEffectMap[K] | null): void;
|
|
64
|
+
/** 读取已设置的效果 */
|
|
65
|
+
get<K extends FrameEffectKey>(key: K): FrameEffectMap[K] | null;
|
|
66
|
+
/**
|
|
67
|
+
* 取某一屏幕坐标上的画面颜色,返回 `#rrggbb`。
|
|
68
|
+
* 画面未就绪或视频源跨域时返回 `null`。
|
|
69
|
+
*/
|
|
70
|
+
pickColor: (clientX: number, clientY: number) => string | null;
|
|
71
|
+
/** 卸载覆盖层、取消渲染循环 */
|
|
72
|
+
dispose: () => void;
|
|
73
|
+
}
|
package/dist/types/plugin.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { default as Artplayer, Setting, SettingOption } from 'artplayer';
|
|
2
|
+
import { FrameRenderer, VideoFilterPreset } from './frame';
|
|
2
3
|
|
|
3
4
|
/** 插件配置的通用形态;具体插件在 `PluginConfigMap` 里声明自己的字段 */
|
|
4
5
|
export type PluginConfig = Record<string, unknown>;
|
|
@@ -74,6 +75,120 @@ export type FilterConfig = {
|
|
|
74
75
|
/** 滑杆步长 */
|
|
75
76
|
step: number;
|
|
76
77
|
};
|
|
78
|
+
/** 网页全屏插件配置 */
|
|
79
|
+
export type WebFullscreenConfig = {
|
|
80
|
+
/** 初始是否处于网页全屏 */
|
|
81
|
+
defaultOn: boolean;
|
|
82
|
+
};
|
|
83
|
+
/** 滑杆型配置的通用区间 */
|
|
84
|
+
export type RangeConfig = {
|
|
85
|
+
/** 滑杆最小值 */
|
|
86
|
+
min: number;
|
|
87
|
+
/** 滑杆最大值 */
|
|
88
|
+
max: number;
|
|
89
|
+
/** 滑杆步长 */
|
|
90
|
+
step: number;
|
|
91
|
+
};
|
|
92
|
+
/** 马赛克插件配置 */
|
|
93
|
+
export type MosaicConfig = RangeConfig & {
|
|
94
|
+
/** 初始是否启用 */
|
|
95
|
+
enabled: boolean;
|
|
96
|
+
/** 初始块大小 */
|
|
97
|
+
size: number;
|
|
98
|
+
};
|
|
99
|
+
/** 防抖插件配置 */
|
|
100
|
+
export type StabilizerConfig = RangeConfig & {
|
|
101
|
+
enabled: boolean;
|
|
102
|
+
/** 初始强度 0–1 */
|
|
103
|
+
strength: number;
|
|
104
|
+
};
|
|
105
|
+
/** 模糊插件配置 */
|
|
106
|
+
export type BlurConfig = RangeConfig & {
|
|
107
|
+
enabled: boolean;
|
|
108
|
+
/** 初始模糊半径(px) */
|
|
109
|
+
radius: number;
|
|
110
|
+
};
|
|
111
|
+
/** 倒放插件配置 */
|
|
112
|
+
export type ReverseConfig = {
|
|
113
|
+
/** 初始是否开启 */
|
|
114
|
+
enabled: boolean;
|
|
115
|
+
/** 初始倒放速率,取 1 时与原速对齐 */
|
|
116
|
+
rate: number;
|
|
117
|
+
};
|
|
118
|
+
/** 背景模糊插件配置 */
|
|
119
|
+
export type BackgroundBlurConfig = RangeConfig & {
|
|
120
|
+
enabled: boolean;
|
|
121
|
+
/** 初始模糊半径(px) */
|
|
122
|
+
radius: number;
|
|
123
|
+
};
|
|
124
|
+
/** 开场动画插件配置 */
|
|
125
|
+
export type IntroConfig = {
|
|
126
|
+
/** 图片地址,留空只显示文字 */
|
|
127
|
+
image: string;
|
|
128
|
+
/** 文案,留空只显示图片 */
|
|
129
|
+
text: string;
|
|
130
|
+
/** 停留时长(毫秒) */
|
|
131
|
+
duration: number;
|
|
132
|
+
/** 延迟出现(毫秒) */
|
|
133
|
+
delay: number;
|
|
134
|
+
/** 是否只在首次播放时出现 */
|
|
135
|
+
once: boolean;
|
|
136
|
+
};
|
|
137
|
+
/** 视频叠加的素材类型 */
|
|
138
|
+
export type OverlayType = 'image' | 'video';
|
|
139
|
+
/** 视频叠加插件配置 */
|
|
140
|
+
export type OverlayConfig = {
|
|
141
|
+
/** 素材地址,留空时菜单只给出提示 */
|
|
142
|
+
src: string;
|
|
143
|
+
/** 素材类型 */
|
|
144
|
+
type: OverlayType;
|
|
145
|
+
/** 中心点横向位置,0–100 */
|
|
146
|
+
x: number;
|
|
147
|
+
/** 中心点纵向位置,0–100 */
|
|
148
|
+
y: number;
|
|
149
|
+
/** 宽度占容器的百分比 */
|
|
150
|
+
width: number;
|
|
151
|
+
/** 不透明度 0–1 */
|
|
152
|
+
opacity: number;
|
|
153
|
+
/** 是否允许拖拽 */
|
|
154
|
+
draggable: boolean;
|
|
155
|
+
/** 视频素材是否静音循环 */
|
|
156
|
+
loop: boolean;
|
|
157
|
+
};
|
|
158
|
+
/** 绿幕插件配置 */
|
|
159
|
+
export type ChromaKeyConfig = {
|
|
160
|
+
enabled: boolean;
|
|
161
|
+
/** 被抠掉的颜色,`#rrggbb` */
|
|
162
|
+
color: string;
|
|
163
|
+
/** 相似度 0–1 */
|
|
164
|
+
similarity: number;
|
|
165
|
+
/** 边缘羽化 0–1 */
|
|
166
|
+
smoothness: number;
|
|
167
|
+
similarityMin: number;
|
|
168
|
+
similarityMax: number;
|
|
169
|
+
smoothnessMin: number;
|
|
170
|
+
smoothnessMax: number;
|
|
171
|
+
};
|
|
172
|
+
/** 视频滤镜插件配置 */
|
|
173
|
+
export type VideoFilterConfig = RangeConfig & {
|
|
174
|
+
/** 初始预设 */
|
|
175
|
+
preset: VideoFilterPreset;
|
|
176
|
+
/** 初始强度 0–1 */
|
|
177
|
+
intensity: number;
|
|
178
|
+
/** 菜单里可选的预设 */
|
|
179
|
+
presets: VideoFilterPreset[];
|
|
180
|
+
};
|
|
181
|
+
/** 横屏转竖屏的适配方式 */
|
|
182
|
+
export type VerticalMode = 'crop' | 'contain' | 'rotate';
|
|
183
|
+
/** 横屏转竖屏插件配置 */
|
|
184
|
+
export type VerticalConfig = {
|
|
185
|
+
/** 初始是否启用 */
|
|
186
|
+
enabled: boolean;
|
|
187
|
+
/** 初始适配方式 */
|
|
188
|
+
mode: VerticalMode;
|
|
189
|
+
/** 目标容器比例,默认 `9:16` */
|
|
190
|
+
ratio: AspectRatioValue;
|
|
191
|
+
};
|
|
77
192
|
/** 内置插件的配置映射,`plugins` 数组据此推导 `setting` 的入参类型 */
|
|
78
193
|
export type PluginConfigMap = {
|
|
79
194
|
playbackRate: PlaybackRateConfig;
|
|
@@ -83,6 +198,17 @@ export type PluginConfigMap = {
|
|
|
83
198
|
pip: PipConfig;
|
|
84
199
|
abLoop: AbLoopConfig;
|
|
85
200
|
filter: FilterConfig;
|
|
201
|
+
webFullscreen: WebFullscreenConfig;
|
|
202
|
+
mosaic: MosaicConfig;
|
|
203
|
+
stabilizer: StabilizerConfig;
|
|
204
|
+
blur: BlurConfig;
|
|
205
|
+
reverse: ReverseConfig;
|
|
206
|
+
backgroundBlur: BackgroundBlurConfig;
|
|
207
|
+
intro: IntroConfig;
|
|
208
|
+
overlay: OverlayConfig;
|
|
209
|
+
chromaKey: ChromaKeyConfig;
|
|
210
|
+
videoFilter: VideoFilterConfig;
|
|
211
|
+
vertical: VerticalConfig;
|
|
86
212
|
};
|
|
87
213
|
/** 内置插件的 key */
|
|
88
214
|
export type BuiltinPluginKey = keyof PluginConfigMap;
|
|
@@ -106,6 +232,17 @@ export type PluginEntry = {
|
|
|
106
232
|
* 需要在 `setting` 里读到带类型的配置时,用 `pluginEntry('key', (config) => ...)` 生成条目。
|
|
107
233
|
*/
|
|
108
234
|
export type PluginInput = string | PluginEntry;
|
|
235
|
+
/** CSS filter 合成栈,多个插件各占一个 key,合成后统一写入 `video.style.filter` */
|
|
236
|
+
export interface CssFilterStack {
|
|
237
|
+
/** 写入一个 key 的片段,空串视为移除 */
|
|
238
|
+
set: (key: string, fragment: string) => void;
|
|
239
|
+
/** 移除某个 key 的片段 */
|
|
240
|
+
remove: (key: string) => void;
|
|
241
|
+
/** 清空全部片段 */
|
|
242
|
+
clear: () => void;
|
|
243
|
+
/** 当前合成后的 filter 值 */
|
|
244
|
+
readonly value: string;
|
|
245
|
+
}
|
|
109
246
|
/** 插件安装上下文 */
|
|
110
247
|
export interface PluginContext {
|
|
111
248
|
/** artplayer 实例 */
|
|
@@ -117,6 +254,10 @@ export interface PluginContext {
|
|
|
117
254
|
setting: (option: Setting) => SettingOption;
|
|
118
255
|
/** 注册清理回调,组件卸载时先于 `destroy()` 执行 */
|
|
119
256
|
onCleanup: (cleanup: () => void) => void;
|
|
257
|
+
/** 帧渲染器:需要逐帧改画面的插件通过它写效果,多个插件互不覆盖 */
|
|
258
|
+
frame: FrameRenderer;
|
|
259
|
+
/** CSS filter 合成栈:写 `video.style.filter` 请走这里,避免插件之间互相覆盖 */
|
|
260
|
+
cssFilter: CssFilterStack;
|
|
120
261
|
}
|
|
121
262
|
/** 插件定义 */
|
|
122
263
|
export interface PluginDefinition<T extends PluginConfig = PluginConfig> {
|