@xiboplayer/sync 0.1.3 → 0.3.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.
Files changed (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # @xiboplayer/sync
2
+
3
+ **Multi-display synchronization for Xibo video walls.**
4
+
5
+ ## Overview
6
+
7
+ BroadcastChannel-based lead/follower synchronization:
8
+
9
+ - **Lead election** — automatic leader selection among browser tabs/windows
10
+ - **Synchronized playback** — video start coordinated across displays
11
+ - **Layout sync** — all displays transition to the same layout simultaneously
12
+
13
+ Designed for video wall setups where multiple screens show synchronized content.
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ npm install @xiboplayer/sync
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ ```javascript
24
+ import { SyncManager } from '@xiboplayer/sync';
25
+
26
+ const sync = new SyncManager({ displayId: 'screen-1' });
27
+ sync.on('layout-sync', ({ layoutId }) => renderer.show(layoutId));
28
+ sync.init();
29
+ ```
30
+
31
+ ---
32
+
33
+ **Part of the [XiboPlayer SDK](https://github.com/linuxnow/xiboplayer)**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xiboplayer/sync",
3
- "version": "0.1.3",
3
+ "version": "0.3.0",
4
4
  "description": "Multi-display synchronization for Xibo Player",
5
5
  "type": "module",
6
6
  "main": "src/sync-manager.js",