@ekg.training/ekg-video-player 1.2.0 → 1.3.1

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.
Files changed (5) hide show
  1. package/README.md +20 -0
  2. package/README.npm.md +20 -0
  3. package/dist/3rdparty-licenses.txt +225 -0
  4. package/dist/ekg_video_player.bundle.js +1 -1
  5. package/package.json +2 -1
package/README.md CHANGED
@@ -157,6 +157,8 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
157
157
  - `ecgLinks` (string or array): Array of an ECG image links or url of single ECG image link
158
158
  - `ecgNotes` (object): `{ title, content }` for ECG Notes
159
159
  - `allowPiP` (boolean): Enable/disable availability of PIP feature
160
+ - `allowAnalytics` (boolean): Enable/disable Analytics to track user interaction with the video player by using Amplitude
161
+ - `amplitudeApiKey` (string): API key for Amplitude
160
162
 
161
163
  ### thumbnails (object)
162
164
 
@@ -224,6 +226,24 @@ The `translations` object allows you to customize UI text labels and messages. A
224
226
 
225
227
  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.
226
228
 
229
+ ### Amplitude for Product Analytics
230
+
231
+ - `cc_text_toggled` (boolean): tracks whether closed captions (CC) are toggled on or off.
232
+ - `thumbnail_toggled` (boolean): tracks whether the thumbnail preview is toggled on or off.
233
+ - `info_popup_toggled` (boolean): tracks whether the info popup is opened or closed.
234
+ - `in_vid_quiz_toggled` (boolean): tracks whether in-video quizzes are toggled on or off.
235
+ - `ecg_popup_toggled` (boolean): tracks whether the ECG popup is opened or closed.
236
+ - `ecg_notes_toggled` (boolean): tracks whether ECG notes visibility is toggled on or off.
237
+ - `chapter_popup_toggled` (boolean): tracks whether the chapter popup is opened or closed.
238
+ - `chapter_changed` (string): tracks the name of the chapter the user switched to.
239
+ - `pip_mode_toggled` (boolean): tracks whether Picture-in-Picture (PiP) mode is toggled on or off.
240
+ - `fullscreen_mode_toggled` (boolean): tracks whether fullscreen mode is toggled on or off.
241
+ - `handout_popup_toggled` (boolean): tracks whether the handout popup is opened or closed.
242
+ - `handout_file` (string): tracks which handout file the user clicked.
243
+ - `settings_popup_toggled` (boolean): tracks whether the settings popup is opened or closed.
244
+ - `playback_speed_changed` (number): tracks the playback speed chosen by the user.
245
+ - `volume_level_changed` (number): tracks the volume level set by the user.
246
+
227
247
  ### ecgNotes (object)
228
248
 
229
249
  #### Extended ECG Notes Format (With JSON-driven UI Support)
package/README.npm.md CHANGED
@@ -157,6 +157,8 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
157
157
  - `ecgLinks` (string or array): Array of an ECG image links or url of single ECG image link
158
158
  - `ecgNotes` (object): `{ title, content }` for ECG Notes
159
159
  - `allowPiP` (boolean): Enable/disable availability of PIP feature
160
+ - `allowAnalytics` (boolean): Enable/disable Analytics to track user interaction with the video player by using Amplitude
161
+ - `amplitudeApiKey` (string): API key for Amplitude
160
162
 
161
163
  ### thumbnails (object)
162
164
 
@@ -224,6 +226,24 @@ The `translations` object allows you to customize UI text labels and messages. A
224
226
 
225
227
  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.
226
228
 
229
+ ### Amplitude for Product Analytics
230
+
231
+ - `cc_text_toggled` (boolean): tracks whether closed captions (CC) are toggled on or off.
232
+ - `thumbnail_toggled` (boolean): tracks whether the thumbnail preview is toggled on or off.
233
+ - `info_popup_toggled` (boolean): tracks whether the info popup is opened or closed.
234
+ - `in_vid_quiz_toggled` (boolean): tracks whether in-video quizzes are toggled on or off.
235
+ - `ecg_popup_toggled` (boolean): tracks whether the ECG popup is opened or closed.
236
+ - `ecg_notes_toggled` (boolean): tracks whether ECG notes visibility is toggled on or off.
237
+ - `chapter_popup_toggled` (boolean): tracks whether the chapter popup is opened or closed.
238
+ - `chapter_changed` (string): tracks the name of the chapter the user switched to.
239
+ - `pip_mode_toggled` (boolean): tracks whether Picture-in-Picture (PiP) mode is toggled on or off.
240
+ - `fullscreen_mode_toggled` (boolean): tracks whether fullscreen mode is toggled on or off.
241
+ - `handout_popup_toggled` (boolean): tracks whether the handout popup is opened or closed.
242
+ - `handout_file` (string): tracks which handout file the user clicked.
243
+ - `settings_popup_toggled` (boolean): tracks whether the settings popup is opened or closed.
244
+ - `playback_speed_changed` (number): tracks the playback speed chosen by the user.
245
+ - `volume_level_changed` (number): tracks the volume level set by the user.
246
+
227
247
  ### ecgNotes (object)
228
248
 
229
249
  #### Extended ECG Notes Format (With JSON-driven UI Support)
package/dist/3rdparty-licenses.txt CHANGED
@@ -1,3 +1,203 @@
1
+ @amplitude/analytics-browser
2
+ MIT
3
+ MIT License
4
+
5
+ Copyright (c) 2022 Amplitude Analytics
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in all
15
+ copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ SOFTWARE.
24
+
25
+
26
+ @amplitude/analytics-connector
27
+ MIT
28
+ MIT License
29
+
30
+ Copyright (c) 2020 Amplitude Analytics
31
+
32
+ Permission is hereby granted, free of charge, to any person obtaining a copy
33
+ of this software and associated documentation files (the "Software"), to deal
34
+ in the Software without restriction, including without limitation the rights
35
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
36
+ copies of the Software, and to permit persons to whom the Software is
37
+ furnished to do so, subject to the following conditions:
38
+
39
+ The above copyright notice and this permission notice shall be included in all
40
+ copies or substantial portions of the Software.
41
+
42
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
45
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
46
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
47
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
48
+ SOFTWARE.
49
+
50
+
51
+ @amplitude/analytics-core
52
+ MIT
53
+ MIT License
54
+
55
+ Copyright (c) 2022 Amplitude Analytics
56
+
57
+ Permission is hereby granted, free of charge, to any person obtaining a copy
58
+ of this software and associated documentation files (the "Software"), to deal
59
+ in the Software without restriction, including without limitation the rights
60
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
61
+ copies of the Software, and to permit persons to whom the Software is
62
+ furnished to do so, subject to the following conditions:
63
+
64
+ The above copyright notice and this permission notice shall be included in all
65
+ copies or substantial portions of the Software.
66
+
67
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
68
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
69
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
70
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
71
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
72
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
73
+ SOFTWARE.
74
+
75
+
76
+ @amplitude/plugin-autocapture-browser
77
+ MIT
78
+ MIT License
79
+
80
+ Copyright (c) 2022 Amplitude Analytics
81
+
82
+ Permission is hereby granted, free of charge, to any person obtaining a copy
83
+ of this software and associated documentation files (the "Software"), to deal
84
+ in the Software without restriction, including without limitation the rights
85
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
86
+ copies of the Software, and to permit persons to whom the Software is
87
+ furnished to do so, subject to the following conditions:
88
+
89
+ The above copyright notice and this permission notice shall be included in all
90
+ copies or substantial portions of the Software.
91
+
92
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
93
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
94
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
95
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
96
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
97
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
98
+ SOFTWARE.
99
+
100
+
101
+ @amplitude/plugin-network-capture-browser
102
+ MIT
103
+ MIT License
104
+
105
+ Copyright (c) 2022 Amplitude Analytics
106
+
107
+ Permission is hereby granted, free of charge, to any person obtaining a copy
108
+ of this software and associated documentation files (the "Software"), to deal
109
+ in the Software without restriction, including without limitation the rights
110
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
111
+ copies of the Software, and to permit persons to whom the Software is
112
+ furnished to do so, subject to the following conditions:
113
+
114
+ The above copyright notice and this permission notice shall be included in all
115
+ copies or substantial portions of the Software.
116
+
117
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
118
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
119
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
120
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
121
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
122
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
123
+ SOFTWARE.
124
+
125
+
126
+ @amplitude/plugin-page-url-enrichment-browser
127
+ MIT
128
+ MIT License
129
+
130
+ Copyright (c) 2022 Amplitude Analytics
131
+
132
+ Permission is hereby granted, free of charge, to any person obtaining a copy
133
+ of this software and associated documentation files (the "Software"), to deal
134
+ in the Software without restriction, including without limitation the rights
135
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
136
+ copies of the Software, and to permit persons to whom the Software is
137
+ furnished to do so, subject to the following conditions:
138
+
139
+ The above copyright notice and this permission notice shall be included in all
140
+ copies or substantial portions of the Software.
141
+
142
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
143
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
144
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
145
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
146
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
147
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
148
+ SOFTWARE.
149
+
150
+
151
+ @amplitude/plugin-page-view-tracking-browser
152
+ MIT
153
+ MIT License
154
+
155
+ Copyright (c) 2022 Amplitude Analytics
156
+
157
+ Permission is hereby granted, free of charge, to any person obtaining a copy
158
+ of this software and associated documentation files (the "Software"), to deal
159
+ in the Software without restriction, including without limitation the rights
160
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
161
+ copies of the Software, and to permit persons to whom the Software is
162
+ furnished to do so, subject to the following conditions:
163
+
164
+ The above copyright notice and this permission notice shall be included in all
165
+ copies or substantial portions of the Software.
166
+
167
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
168
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
169
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
170
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
171
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
172
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
173
+ SOFTWARE.
174
+
175
+
176
+ @amplitude/plugin-web-vitals-browser
177
+ MIT
178
+ MIT License
179
+
180
+ Copyright (c) 2022 Amplitude Analytics
181
+
182
+ Permission is hereby granted, free of charge, to any person obtaining a copy
183
+ of this software and associated documentation files (the "Software"), to deal
184
+ in the Software without restriction, including without limitation the rights
185
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
186
+ copies of the Software, and to permit persons to whom the Software is
187
+ furnished to do so, subject to the following conditions:
188
+
189
+ The above copyright notice and this permission notice shall be included in all
190
+ copies or substantial portions of the Software.
191
+
192
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
193
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
194
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
195
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
196
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
197
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
198
+ SOFTWARE.
199
+
200
+
1
201
  @vidstack/react
2
202
  MIT
3
203
  MIT License
@@ -272,3 +472,28 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
272
472
  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
273
473
  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
274
474
  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
475
+
476
+
477
+ zen-observable-ts
478
+ MIT
479
+ The MIT License (MIT)
480
+
481
+ Copyright (c) 2021 Apollo Graph, Inc. (Formerly Meteor Development Group, Inc.)
482
+
483
+ Permission is hereby granted, free of charge, to any person obtaining a copy
484
+ of this software and associated documentation files (the "Software"), to deal
485
+ in the Software without restriction, including without limitation the rights
486
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
487
+ copies of the Software, and to permit persons to whom the Software is
488
+ furnished to do so, subject to the following conditions:
489
+
490
+ The above copyright notice and this permission notice shall be included in all
491
+ copies or substantial portions of the Software.
492
+
493
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
494
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
495
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
496
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
497
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
498
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
499
+ SOFTWARE.