@universal-web-video-player/player-web-component 0.5.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 +54 -0
- package/dist/index.cjs +1226 -0
- package/dist/index.d.cts +203 -0
- package/dist/index.d.ts +203 -0
- package/dist/index.global.js +1300 -0
- package/dist/index.js +1226 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# @universal-web-video-player/player-web-component
|
|
2
|
+
|
|
3
|
+
The custom element adapter for the Universal Video Player.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @universal-web-video-player/player-web-component
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### In HTML (via CDN)
|
|
14
|
+
|
|
15
|
+
#### ESM (Recommended)
|
|
16
|
+
```html
|
|
17
|
+
<script type="module" src="https://cdn.jsdelivr.net/npm/@universal-web-video-player/player-web-component/dist/index.js"></script>
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
#### Global IIFE
|
|
21
|
+
```html
|
|
22
|
+
<script src="https://cdn.jsdelivr.net/npm/@universal-web-video-player/player-web-component/dist/index.global.js"></script>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
#### Usage
|
|
26
|
+
```html
|
|
27
|
+
<uvp-player
|
|
28
|
+
source-url="https://example.com/video.mp4"
|
|
29
|
+
poster="https://example.com/poster.jpg"
|
|
30
|
+
autoplay
|
|
31
|
+
></uvp-player>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### In JavaScript
|
|
35
|
+
|
|
36
|
+
```javascript
|
|
37
|
+
import { defineUvpPlayerElement } from '@universal-web-video-player/player-web-component';
|
|
38
|
+
|
|
39
|
+
// Register the custom element
|
|
40
|
+
defineUvpPlayerElement();
|
|
41
|
+
|
|
42
|
+
const player = document.querySelector('uvp-player');
|
|
43
|
+
player.play();
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Attributes
|
|
47
|
+
|
|
48
|
+
- `source-url`: URL of the video.
|
|
49
|
+
- `source-type`: `mp4`, `hls`, or `dash`.
|
|
50
|
+
- `autoplay`: Boolean.
|
|
51
|
+
- `muted`: Boolean.
|
|
52
|
+
- `poster`: Poster image URL.
|
|
53
|
+
- `controls`: Boolean (default `true`).
|
|
54
|
+
- `playlist`: JSON string of `UvpSourceItem[]`.
|