@lightbird/core 0.1.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Punyam Singh
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # @lightbird/core
2
+
3
+ Client-side video player engine for the browser. Plays MKV, MP4, WebM, AVI, and more — with full subtitle, audio track, and chapter support. No server required.
4
+
5
+ **[Documentation](https://lightbird.vercel.app/docs)** | **[Live Demo](https://lightbird.vercel.app)** | **[GitHub](https://github.com/punyamsingh/lightbird)**
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install @lightbird/core
11
+ ```
12
+
13
+ ## Quick Start
14
+
15
+ ```ts
16
+ import { createVideoPlayer } from '@lightbird/core'
17
+
18
+ const player = createVideoPlayer(file)
19
+ await player.initialize(videoElement)
20
+ ```
21
+
22
+ ### React Hooks
23
+
24
+ ```tsx
25
+ import { useVideoPlayback, useSubtitles } from '@lightbird/core/react'
26
+
27
+ const { isPlaying, togglePlay, seek } = useVideoPlayback(videoRef)
28
+ ```
29
+
30
+ ### Full UI Component
31
+
32
+ ```bash
33
+ npm install @lightbird/core @lightbird/ui
34
+ ```
35
+
36
+ ```tsx
37
+ import { LightBirdPlayer } from '@lightbird/ui'
38
+
39
+ <LightBirdPlayer />
40
+ ```
41
+
42
+ ## Features
43
+
44
+ - **MKV playback** — FFmpeg.wasm client-side remuxing
45
+ - **Subtitles** — SRT, VTT, ASS/SSA with encoding detection and sync offset
46
+ - **Audio tracks** — Multi-track switching for MKV
47
+ - **Chapters** — Auto-extraction, seek bar markers, navigation
48
+ - **Playlist** — Drag-and-drop, M3U8 import/export
49
+ - **More** — PiP, Media Session, keyboard shortcuts, video filters, screenshots
50
+
51
+ ## Documentation
52
+
53
+ Full API reference, examples, and integration guides at **[lightbird.vercel.app/docs](https://lightbird.vercel.app/docs)**
54
+
55
+ ## License
56
+
57
+ MIT