fleetplayer - npm Package Compare versions

Comparing version 1.0.0 to 1.0.2

README.md

+# FleetPlayer 🚀
+
+A high-performance, framework-agnostic, and headless HLS video player engine built with TypeScript and Media Source Extensions (MSE). 
+
+FleetPlayer is designed to be lightweight and modular, providing a powerful streaming core while giving developers complete control over the UI.
+
+## ✨ Features
+
+- **HLS Support**: Play `.m3u8` streams using Media Source Extensions (MSE).
+- **Native Fallback**: Automatically switches to the browser's native HLS pipeline (e.g., Safari, iOS) for maximum compatibility.
+- **Adaptive Bitrate (ABR)**: Real-time quality switching based on measured network throughput.
+- **Headless Core**: No UI dependencies. Build your own controls or use a wrapper.
+- **Web Worker Powered**: Bandwidth estimation and segment fetching handled off the main thread.
+- **TypeScript First**: Full type definitions included for a superior developer experience.
+- **Framework Agnostic**: Works seamlessly with React, Vue, Angular, Svelte, or Vanilla JavaScript.
+
+## 📦 Installation
+
+```bash
+npm install fleetplayer
+```
+
+## 🚀 Quick Start
+
+### 1. Basic Usage (Vanilla JS)
+
+```html
+<video id="my-video" controls></video>
+
+<script type="module">
+  import { FleetPlayer } from 'fleetplayer';
+
+  const videoElement = document.getElementById('my-video');
+  const player = new FleetPlayer(videoElement, {
+    autoStart: true
+  });
+
+  // Load an HLS stream
+  await player.load('https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8');
+</script>
+```
+
+### 2. Usage in React
+
+```tsx
+import React, { useEffect, useRef } from 'react';
+import { FleetPlayer } from 'fleetplayer';
+
+const VideoPlayer = () => {
+  const videoRef = useRef<HTMLVideoElement>(null);
+  const playerRef = useRef<FleetPlayer | null>(null);
+
+  useEffect(() => {
+    if (videoRef.current) {
+      playerRef.current = new FleetPlayer(videoRef.current);
+      playerRef.current.load('your-stream-url.m3u8');
+    }
+
+    return () => {
+      playerRef.current?.destroy();
+    };
+  }, []);
+
+  return <video ref={videoRef} controls style={{ width: '100%' }} />;
+};
+```
+
+## 🛠️ API Reference
+
+### `new FleetPlayer(videoElement, config?)`
+Initializes a new player instance.
+- `videoElement`: The HTMLVideoElement to attach to.
+- `config`: (Optional) `{ autoStart?: boolean }`
+
+### `player.load(url: string): Promise<void>`
+Parses the manifest and prepares the player for playback.
+
+### `player.play() / player.pause()`
+Standard playback controls.
+
+### `player.setQuality(levelIndex: number)`
+Manually set the quality level.
+- `levelIndex`: The index of the level from `getStats().levels`.
+- Pass `-1` for **Auto ABR** (default).
+
+### `player.getStats()`
+Returns an object containing real-time performance data:
+```javascript
+{
+  buffered: [{ start: number, end: number }],
+  bitrate: number, // Current bitrate in bps
+  level: number,   // Current quality level index
+  levels: [...]    // Available quality levels
+}
+```
+
+### `player.destroy()`
+Cleans up internal resources, stops workers, and resets the video source.
+
+## 📄 License
+
+MIT © [aniketyadav](https://github.com/aniketyadav2003)

package.json

 {
   "name": "fleetplayer",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "High-performance, headless HLS video player engine using MSE and TypeScript.",
@@ -5,0 +5,0 @@ "main": "./dist/fleetplayer.umd.js",

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

86094

3.84%

Number of package files

20

5.26%

Number of medium quality alerts

0

-100%

Number of lines in readme file

103

Infinity%

No dependency changes