Modular JavaScript SDK for building Xibo digital signage players. Each package handles one concern — combine them to build a full player, or use individual packages in your own projects.

All packages are published to npm under the @xiboplayer scope.

• Dual transport — XMDS SOAP v3–v7 and REST API v2 with automatic protocol detection and idempotent cache-through (both transports converge on the same proxy mirror paths)
• XMR real-time commands — collectNow, screenshot, changeLayout, overlayLayout, revertToSchedule, purgeAll, dataUpdate via WebSocket with auto-reconnect
• Network resilience — exponential backoff with jitter, CRC32-based skip optimization, ETag HTTP caching, HTTP 429 Retry-After support
• CMS REST API client — 77 methods covering layouts, campaigns, schedules, commands, displays, playlists, datasets, notifications, folders, tags, and display group actions
• RSA key pair generation for XMR display registration via Web Crypto API

• Rich media — video (MP4/HLS), images (scaleType, align/valign), audio (with overlay visualization), PDF, text/ticker, web pages, clock, calendar, weather, and all CMS widget types
• Layout preloading — 2-layout pool pre-builds upcoming layouts at 75% of current duration for instant zero-gap transitions
• Transitions — fade and fly (8-direction compass) via Web Animations API, including region exit transitions
• Interactive actions — touch/click and keyboard triggers for widget navigation, layout jumps, and command execution
• Canvas regions, drawer regions, sub-playlists — full support for advanced CMS layout features
• Shell commands — native command execution via Electron IPC and Chromium HTTP endpoint

• Campaign scheduling — priority-based campaigns, daily/weekly/monthly dayparting with midnight-crossing, geo-fencing, and criteria evaluation
• Interrupts / share of voice — percentage-based interrupt scheduling with even interleaving across the hour
• Overlays — multiple simultaneous overlay layouts with independent scheduling and priority
• Timeline prediction — deterministic future schedule simulation for proactive content preloading
• Weather criteria — weather-based schedule evaluation with geolocation fallback chain (browser API → Google API → IP lookup)

• Offline-first — ContentStore (filesystem via proxy) + IndexedDB storage with automatic fallback to cached schedule
• Parallel chunk downloads — large files split into 50MB chunks, header+trailer first for instant MP4 playback start
• Download resume — incomplete chunked downloads resume from last successful chunk
• Download window enforcement — respects CMS-configured time windows to avoid bandwidth during peak hours

• Multi-display sync — lead/follower synchronization with <8ms precision, coordinated layout transitions and video start
• mDNS auto-discovery — leads advertise via _xibo-sync._tcp, followers discover automatically. No manual IP configuration needed.
• 12 choreography effects — diagonal cascade, wave sweep (4 directions), center-out, outside-in, random — configurable stagger delay per display
• Same-machine — BroadcastChannel for multi-tab/multi-window setups
• Cross-device — WebSocket relay on the lead's proxy server for LAN video walls (each screen a separate PC)
• Stats delegation — followers delegate proof-of-play through the lead, avoiding duplicate CMS traffic
• DHCP-friendly — followers re-discover lead IP on each collection cycle; no static IPs required

• Proof of play — per-layout and per-widget duration tracking with individual or aggregated submission
• Event-based stats — widget interactions and recordEvent for engagement analytics
• Fault reporting — independent 60s cycle for faster CMS alerts, layout blacklisting after 3 consecutive failures
• Screenshot capture — periodic and on-demand via getDisplayMedia + html2canvas fallback

• CORS proxy — shared Express server for Electron and Chromium shells with XMDS, REST, and file download proxying plus PWA static serving. Cache-through accepts X-Cms-Download-Url for XMDS-only CMSes
• Protocol auto-detection — probes REST API at startup, auto-selects REST or SOAP transport
• Persistent layout durations — cached in IndexedDB for correct timeline on restart
• 1656 tests across 50 test suites

Package	npm	Description
@xiboplayer/core		Player orchestration, collection cycle, offline mode, layout state machine
@xiboplayer/renderer		XLF layout rendering — video, image, PDF, text, web, transitions, actions, preloading
@xiboplayer/schedule		Campaigns, dayparting, interrupts, overlays, geo-fencing, criteria, timeline
@xiboplayer/xmds		XMDS SOAP + REST client — RegisterDisplay, RequiredFiles, Schedule, GetResource, stats
@xiboplayer/xmr		XMR WebSocket — real-time commands with auto-reconnect
@xiboplayer/cache		Offline cache — parallel chunk downloads, MD5 verification, download queue
@xiboplayer/stats		Proof of play, log reporting, fault alerts with deduplication
@xiboplayer/settings		CMS display settings — resolution, intervals, download windows, screenshot config
@xiboplayer/crypto		RSA key generation for XMR registration (Web Crypto API)
@xiboplayer/utils		EventEmitter, logger, fetchWithRetry, CMS REST API client, config
@xiboplayer/sw		Service Worker — media caching, range requests, widget HTML serving
@xiboplayer/sync		Cross-device video walls — BroadcastChannel + WebSocket relay, lead/follower sync
@xiboplayer/proxy		CORS proxy + PWA server — shared by Electron and Chromium shells

Install all packages at once:

npm install @xiboplayer/core @xiboplayer/renderer @xiboplayer/schedule \
  @xiboplayer/xmds @xiboplayer/xmr @xiboplayer/cache @xiboplayer/stats \
  @xiboplayer/settings @xiboplayer/utils @xiboplayer/sync @xiboplayer/proxy

Or install only what you need:

npm install @xiboplayer/xmds    # just the CMS SOAP client
npm install @xiboplayer/cache   # just the offline cache
npm install @xiboplayer/proxy   # CORS proxy + PWA server for shells

┌─────────────────────────────────────────────────────────┐
│                    @xiboplayer/core                      │
│         collection cycle · offline mode · events         │
├──────────┬──────────┬──────────┬──────────┬─────────────┤
│ renderer │ schedule │  cache   │  stats   │  settings   │
│  layout  │ campaign │ offline  │ proof of │  display    │
│ widgets  │ daypart  │  chunks  │   play   │  config     │
│ actions  │interrupt │   MD5    │  logs    │  windows    │
├──────────┴──────────┴──────────┴──────────┴─────────────┤
│       @xiboplayer/xmds            @xiboplayer/xmr       │
│   SOAP + REST ↔ CMS           WebSocket ↔ CMS push     │
├─────────────────────────────────────────────────────────┤
│ @xiboplayer/proxy  @xiboplayer/utils  @xiboplayer/sync crypto│
│  CORS proxy · PWA    logger · events   video wall    RSA  │
│  sync relay          fetch · config    BC + WebSocket keys │
└─────────────────────────────────────────────────────────┘

The SDK supports three communication channels:

XMDS methods: RegisterDisplay, RequiredFiles, Schedule, GetResource, NotifyStatus, MediaInventory, BlackList, SubmitStats, SubmitScreenShot, SubmitLog

XMR commands: collectNow, screenshot, changeLayout, overlayLayout, revertToSchedule, purgeAll, dataUpdate, triggerWebhook, commandAction, criteriaUpdate, currentGeoLocation

The renderer parses Xibo Layout Format (XLF) files and builds a live DOM with:

Layout features: proportional scaling with ResizeObserver, overlay support (z-index 1000+), 2-layout preload pool for zero-gap transitions, element reuse on same-layout replay, media-ready gating (layout timer starts only when all first widgets are loaded).

RPM and DEB packages are available from dl.xiboplayer.org.

• Node.js 20+
• pnpm 10+

pnpm install

pnpm test              # run all tests (1656 tests across 50 suites)
pnpm lint              # Biome linter
pnpm test:watch        # watch mode
pnpm test:coverage     # with coverage report

This is a pnpm workspace monorepo. Packages use workspace:* internally; pnpm converts these to semver ranges on publish.

AGPL-3.0-or-later