@scarlett-player/airplay 0.1.0 → 0.1.2

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 (2) hide show
  1. package/README.md +63 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,63 @@
1
+ # @scarlett-player/airplay
2
+
3
+ AirPlay casting plugin for Scarlett Player. Enables wireless streaming to Apple TV and AirPlay-compatible devices.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @scarlett-player/core @scarlett-player/airplay
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```typescript
14
+ import { ScarlettPlayer } from '@scarlett-player/core';
15
+ import { createHLSPlugin } from '@scarlett-player/hls';
16
+ import { airplayPlugin } from '@scarlett-player/airplay';
17
+
18
+ const player = new ScarlettPlayer({
19
+ container: document.getElementById('player'),
20
+ plugins: [createHLSPlugin(), airplayPlugin()],
21
+ });
22
+
23
+ // Show AirPlay picker (Safari only)
24
+ player.requestAirPlay();
25
+ ```
26
+
27
+ ## Browser Support
28
+
29
+ AirPlay is only supported in **Safari** on macOS and iOS.
30
+
31
+ ## API
32
+
33
+ ```typescript
34
+ // Check if AirPlay is available
35
+ const plugin = player.getPlugin('airplay');
36
+ plugin.isAvailable(); // true if AirPlay devices detected
37
+
38
+ // Check if currently casting
39
+ plugin.isActive(); // true if casting to AirPlay
40
+
41
+ // Show device picker
42
+ plugin.showPicker();
43
+ ```
44
+
45
+ ## Events
46
+
47
+ ```typescript
48
+ player.on('airplay:available', () => {
49
+ // AirPlay devices detected
50
+ });
51
+
52
+ player.on('airplay:connected', () => {
53
+ // Started casting
54
+ });
55
+
56
+ player.on('airplay:disconnected', () => {
57
+ // Stopped casting
58
+ });
59
+ ```
60
+
61
+ ## License
62
+
63
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scarlett-player/airplay",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "AirPlay Plugin for Scarlett Player",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -27,7 +27,7 @@
27
27
  "@scarlett-player/core": "^0.1.0"
28
28
  },
29
29
  "devDependencies": {
30
- "@scarlett-player/core": "file:../../core",
30
+ "@scarlett-player/core": "workspace:*",
31
31
  "typescript": "^5.3.0",
32
32
  "tsup": "^8.0.0",
33
33
  "vitest": "^1.6.0",
@@ -51,5 +51,5 @@
51
51
  "bugs": {
52
52
  "url": "https://github.com/Hackney-Enterprises-Inc/scarlett-player/issues"
53
53
  },
54
- "homepage": "https://github.com/Hackney-Enterprises-Inc/scarlett-player#readme"
54
+ "homepage": "https://scarlettplayer.com"
55
55
  }