@ekg.training/ekg-video-player 1.0.4 → 1.0.5
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 +10 -0
- package/README.npm.md +10 -0
- package/dist/ekg_video_player.bundle.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,6 +13,7 @@ A customizable React-based video player library, supporting both React and plain
|
|
|
13
13
|
- [React](#react)
|
|
14
14
|
- [ESM (Browser)](#esm-browser)
|
|
15
15
|
- [UMD (Browser)](#umd-browser)
|
|
16
|
+
- [Limitations](#limitations)
|
|
16
17
|
- [Player Props Reference](#player-props-reference)
|
|
17
18
|
- [Top-level Config Object](#top-level-config-object)
|
|
18
19
|
- [mediaPlayerProps (object)](#mediaplayerprops-object)
|
|
@@ -78,6 +79,10 @@ useEffect(() => {
|
|
|
78
79
|
</script>
|
|
79
80
|
```
|
|
80
81
|
|
|
82
|
+
## Limitations
|
|
83
|
+
|
|
84
|
+
1. No UI support for youtube videos.
|
|
85
|
+
|
|
81
86
|
## Player Props Reference
|
|
82
87
|
|
|
83
88
|
The configuration object passed to `new VideoPlayer('root', config)` (standalone JS) or as props in React usage supports the following keys. The same structure is used in both approaches.
|
|
@@ -108,6 +113,7 @@ For a full working config, see [examples/React/src/App.js](https://github.com/cl
|
|
|
108
113
|
- `logLevel` (string): Logging level
|
|
109
114
|
- `crossOrigin` (boolean): Set crossorigin attribute
|
|
110
115
|
- `playsInline` (boolean): Play inline on mobile
|
|
116
|
+
- `trackUserPreferences` (boolean): Enable/disable tracking of user preferences
|
|
111
117
|
- `loop` (boolean): Loop playback
|
|
112
118
|
- `onPause`, `onPlay`, `onPlaying`, `onLoopChange`, `onTimeUpdate`, `onLoad` (function): Event handlers
|
|
113
119
|
|
|
@@ -140,6 +146,7 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
|
|
|
140
146
|
`handouts` (array): Downloadable handout objects (`{ language, title, url }`)
|
|
141
147
|
`quizzes` (array): Quiz objects (see [`examples/React/src/App.js`](examples/React/src/App.js))
|
|
142
148
|
- `isSkipQuiz` (boolean): Enable/disable quiz skipping
|
|
149
|
+
**Order in which factors are affecting visibility of quiz** - 1. mediaPlayerProps.trackUserPreferences if this flag is true, then isSkipQuiz value in 'custom-pref-storage' localstorage 2. videoLayoutProps.isSkipQuiz 3. default is true (i.e Quiz will not be visible)
|
|
143
150
|
- `isPseudoFullscreen` (boolean): iOS fullscreen workaround
|
|
144
151
|
- `toggleSkipQuiz`, `toggleIphoneFullScreen`, `toggleInfo` (function): UI toggles
|
|
145
152
|
- `isQuizOpen`, `isInfoOpen` (boolean): UI state
|
|
@@ -147,6 +154,7 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
|
|
|
147
154
|
- `windowProps` (object): Window size/orientation
|
|
148
155
|
- `translations` (object): UI translations
|
|
149
156
|
- `infoLink` (string): The link (image or video) to player information (e.g. instructions to use player)
|
|
157
|
+
- `allowPiP` (boolean): Enable/disable availability of PIP feature
|
|
150
158
|
|
|
151
159
|
### audioLayoutProps (object)
|
|
152
160
|
|
|
@@ -193,6 +201,8 @@ The `translations` object allows you to customize UI text labels and messages. A
|
|
|
193
201
|
| minLabel | Minutes label |
|
|
194
202
|
| showInfoLabel | Show toolbar info label |
|
|
195
203
|
| hideInfoLabel | Hide toolbar info label |
|
|
204
|
+
| warningLabel | WARNING text |
|
|
205
|
+
| slowInternetSpeedWarning | Slow internet speed warning |
|
|
196
206
|
|
|
197
207
|
See [examples/React/src/App.js](https://github.com/close2realtraining/ekg-video-player/blob/main/examples/React/src/App.js) and [src/index.tsx](https://github.com/close2realtraining/ekg-video-player/blob/main/src/index.tsx) for real-world usage.
|
|
198
208
|
|
package/README.npm.md
CHANGED
|
@@ -13,6 +13,7 @@ A customizable React-based video player library, supporting both React and plain
|
|
|
13
13
|
- [React](#react)
|
|
14
14
|
- [ESM (Browser)](#esm-browser)
|
|
15
15
|
- [UMD (Browser)](#umd-browser)
|
|
16
|
+
- [Limitations](#limitations)
|
|
16
17
|
- [Player Props Reference](#player-props-reference)
|
|
17
18
|
- [Top-level Config Object](#top-level-config-object)
|
|
18
19
|
- [mediaPlayerProps (object)](#mediaplayerprops-object)
|
|
@@ -78,6 +79,10 @@ useEffect(() => {
|
|
|
78
79
|
</script>
|
|
79
80
|
```
|
|
80
81
|
|
|
82
|
+
## Limitations
|
|
83
|
+
|
|
84
|
+
1. No UI support for youtube videos.
|
|
85
|
+
|
|
81
86
|
## Player Props Reference
|
|
82
87
|
|
|
83
88
|
The configuration object passed to `new VideoPlayer('root', config)` (standalone JS) or as props in React usage supports the following keys. The same structure is used in both approaches.
|
|
@@ -108,6 +113,7 @@ For a full working config, see [examples/React/src/App.js](https://github.com/cl
|
|
|
108
113
|
- `logLevel` (string): Logging level
|
|
109
114
|
- `crossOrigin` (boolean): Set crossorigin attribute
|
|
110
115
|
- `playsInline` (boolean): Play inline on mobile
|
|
116
|
+
- `trackUserPreferences` (boolean): Enable/disable tracking of user preferences
|
|
111
117
|
- `loop` (boolean): Loop playback
|
|
112
118
|
- `onPause`, `onPlay`, `onPlaying`, `onLoopChange`, `onTimeUpdate`, `onLoad` (function): Event handlers
|
|
113
119
|
|
|
@@ -140,6 +146,7 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
|
|
|
140
146
|
`handouts` (array): Downloadable handout objects (`{ language, title, url }`)
|
|
141
147
|
`quizzes` (array): Quiz objects (see [`examples/React/src/App.js`](examples/React/src/App.js))
|
|
142
148
|
- `isSkipQuiz` (boolean): Enable/disable quiz skipping
|
|
149
|
+
**Order in which factors are affecting visibility of quiz** - 1. mediaPlayerProps.trackUserPreferences if this flag is true, then isSkipQuiz value in 'custom-pref-storage' localstorage 2. videoLayoutProps.isSkipQuiz 3. default is true (i.e Quiz will not be visible)
|
|
143
150
|
- `isPseudoFullscreen` (boolean): iOS fullscreen workaround
|
|
144
151
|
- `toggleSkipQuiz`, `toggleIphoneFullScreen`, `toggleInfo` (function): UI toggles
|
|
145
152
|
- `isQuizOpen`, `isInfoOpen` (boolean): UI state
|
|
@@ -147,6 +154,7 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
|
|
|
147
154
|
- `windowProps` (object): Window size/orientation
|
|
148
155
|
- `translations` (object): UI translations
|
|
149
156
|
- `infoLink` (string): The link (image or video) to player information (e.g. instructions to use player)
|
|
157
|
+
- `allowPiP` (boolean): Enable/disable availability of PIP feature
|
|
150
158
|
|
|
151
159
|
### audioLayoutProps (object)
|
|
152
160
|
|
|
@@ -193,6 +201,8 @@ The `translations` object allows you to customize UI text labels and messages. A
|
|
|
193
201
|
| minLabel | Minutes label |
|
|
194
202
|
| showInfoLabel | Show toolbar info label |
|
|
195
203
|
| hideInfoLabel | Hide toolbar info label |
|
|
204
|
+
| warningLabel | WARNING text |
|
|
205
|
+
| slowInternetSpeedWarning | Slow internet speed warning |
|
|
196
206
|
|
|
197
207
|
See [examples/React/src/App.js](https://github.com/close2realtraining/ekg-video-player/blob/main/examples/React/src/App.js) and [src/index.tsx](https://github.com/close2realtraining/ekg-video-player/blob/main/src/index.tsx) for real-world usage.
|
|
198
208
|
|