# 软水印插件
内置于superplayer，播放腾讯视频内容时会根据后台返回进行展示。
申请免水印注意事项：
- 默认正片有硬水印的不能免，可能存在hls格式是软水印，在h5播mp4是硬水印的情况
- 软水印视频可以按独立平台号申请
# 引入
npm install --save @tencent/thumbplayer-plugin-watermark
import { WatermarkPlugin } from '@tencent/thumbplayer-plugin-watermark';
const player = new SuperPlayer({
container: '#container'
plugins: [WatermarkPlugin.pluginName]
})
player.on(H5_PLAY_EVENT.VIDEO_PLAYING, () => {
const wm = player.getPlugin(WatermarkPlugin.pluginName).add(watermark); //添加新水印
wm.show(); //展示
wm.hide(); //隐藏
player.getPlugin(WatermarkPlugin.pluginName).schedule(id, 5, 10);
//...
})
# 配置
引入后可以通过watermarkConfig节点设置。
# fallbackWatermark
• Optional fallbackWatermark: string
默认静态水印地址，静态水印加载失败后调用
# 水印参数
# a
• a: number
透明度，0-100
# h
• h: number
水印相对于视频的高度
# id
• id: string | number
水印id，key
# url
• url: string
水印url地址
# w
• w: number
水印相对于视频的宽度
# x
• x: number
水印右上角相对于视频右上角的x坐标
# y
• y: number
水印右上角相对于视频右上角的y坐标
# 插件API
# add
▸ add(watermark: IWatermark, showOnInit?: boolean): Watermark
添加一个新的水印
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
watermark | IWatermark | - | 水印的参数，包括大小，相对位置，以及图片url |
showOnInit | boolean | false | - |
Returns: Watermark
# clear
▸ clear(): void
销毁所有的水印，清空缓存
Returns: void
# destroy
▸ destroy(): void
销毁插件，移除dom元素
Returns: void
# get
▸ get(id: string | number): [Watermark, IWatermark]
获取指定id的水印实例
# Parameters:
| Name | Type | Description |
|---|---|---|
id | string | number | 水印的id |
Returns: [Watermark, IWatermark]
# remove
▸ remove(id: string | number): void
移除指定id的水印, 同时移除对应的时间表
# Parameters:
| Name | Type | Description |
|---|---|---|
id | string | number | 需要移除的水印的id |
Returns: void
# schedule
▸ schedule(id: string | number, start: number, end?: number): void
设定指定id的水印的显示时间, 水印不存在时跳过
# Parameters:
| Name | Type | Description |
|---|---|---|
id | string | number | 水印的id |
start | number | 开始显示的时间，单位秒 |
end? | number | 结束显示的时间，单位秒 |
Returns: void
# unschedule
▸ unschedule(id: number): void
注销指定id的水印的时间表
# Parameters:
| Name | Type | Description |
|---|---|---|
id | number | 需要清空时间表的水印的id |
Returns: void
# watermarkThis
▸ watermarkThis(text: string): HTMLDivElement
为容器添加一个水印遮罩
# Parameters:
| Name | Type | Description |
|---|---|---|
text | string | 水印文字 |
Returns: HTMLDivElement
# 水印实例API
# destroy
▸ destroy(): void
Returns: void
# draw
▸ draw(css: Partial<CSSStyleDeclaration>): void
# Parameters:
| Name | Type |
|---|---|
css | Partial<CSSStyleDeclaration> |
Returns: void
# hide
▸ hide(): void
Returns: void
# show
▸ show(): void
Returns: void