@playkit-js/manual-hotspots 3.3.1 → 3.3.2-canary.0-3bf0c5b
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/docs/configuration.md
CHANGED
|
@@ -5,6 +5,8 @@ This document provides comprehensive configuration options for the PlayKit JS Ma
|
|
|
5
5
|
## Table of Contents
|
|
6
6
|
|
|
7
7
|
- [Basic Usage](#basic-usage)
|
|
8
|
+
- [Plugin Options](#plugin-options)
|
|
9
|
+
- [Safe Area Insets](#safe-area-insets)
|
|
8
10
|
- [Hotspot Configuration](#hotspot-configuration)
|
|
9
11
|
- [Minimal Configuration](#minimal-configuration)
|
|
10
12
|
- [Full Configuration](#full-configuration)
|
|
@@ -42,6 +44,35 @@ const config = {
|
|
|
42
44
|
|
|
43
45
|
---
|
|
44
46
|
|
|
47
|
+
## Plugin Options
|
|
48
|
+
|
|
49
|
+
### Safe Area Insets
|
|
50
|
+
|
|
51
|
+
Use `safeAreaInsets` to keep hotspots inside a padded area within the video frame (values are pixels):
|
|
52
|
+
|
|
53
|
+
```javascript
|
|
54
|
+
const config = {
|
|
55
|
+
plugins: {
|
|
56
|
+
'playkit-js-manual-hotspots': {
|
|
57
|
+
safeAreaInsets: {
|
|
58
|
+
top: 24,
|
|
59
|
+
right: 16,
|
|
60
|
+
bottom: 40,
|
|
61
|
+
left: 16
|
|
62
|
+
},
|
|
63
|
+
hotspots: [
|
|
64
|
+
{
|
|
65
|
+
startTime: 5000,
|
|
66
|
+
label: 'Click me!'
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
45
76
|
## Hotspot Configuration
|
|
46
77
|
|
|
47
78
|
### Minimal Configuration
|