Chaptrr
Digital Signage SDK

Chaptrr Screen Player

A lightweight, cross-platform player for digital signage. Easy setup, offline support, and centralized management from the Chaptrr CMS.

Built for Digital Signage

Auto-Refresh Content

Automatically fetches new playlists from the CMS every 5 minutes

Offline Support

Caches content locally with IndexedDB for uninterrupted playback

Health Monitoring

Reports screen status to the server for real-time monitoring

Analytics Tracking

Records plays for detailed performance reports

Ticker Ribbons

Supports scrolling text overlays with custom content

Secure

API key authentication and HTTPS encryption

Quick Start Guide

Get your screen up and running in minutes

1

Create a Screen in CMS

Log into the CMS dashboard and create a new screen. Note the Screen ID.

2

Download & Run the Player

Download the SDK and open it in a browser or package it as an app.

3

Configure & Connect

Enter your API URL and Screen ID in the setup screen:

API URL:
https://commerce.chaptrr.com
Screen ID:
screen_abc123(from CMS)

You're Ready!

Your screen will now display content from the assigned playlist. Manage content, schedules, and campaigns from the CMS dashboard.

Deployment Options

Choose the deployment method that fits your hardware

Electron Desktop App

Package as a native Windows, Mac, or Linux application

Recommended
  1. 1Install Electron: npm install -g electron
  2. 2Download the SDK files
  3. 3Run: electron .
  4. 4Package for distribution with electron-builder
Android WebView APK

Embed in an Android app for smart TVs and tablets

Popular
  1. 1Create new Android Studio project
  2. 2Add WebView to main layout
  3. 3Enable JavaScript and DOM storage
  4. 4Load player from assets or hosted URL
Raspberry Pi Kiosk

Run on Raspberry Pi with Chromium in kiosk mode

Budget-Friendly
  1. 1Install Chromium browser
  2. 2Copy SDK files to /home/pi/player/
  3. 3Configure autostart in kiosk mode
  4. 4Disable screen blanking
Browser Kiosk

Run directly in any modern web browser

Quick Start
  1. 1Open the player URL in a browser
  2. 2Enter API URL and Screen ID
  3. 3Press F11 for fullscreen
  4. 4Configure browser to auto-start

API Reference

Endpoints used by the Screen Player

Screen Player API Endpoints

GET
/api/cms/player/content/{screen_id}

Fetch playlist content for a screen

POST
/api/cms/screens/{screen_id}/ping

Send health ping to server

POST
/api/cms/player/play

Record media play for analytics

Keyboard Shortcuts

Quick controls for the Screen Player

Toggle setup screenS
Refresh content from serverR
Skip to next mediaN
Show status info overlayI

Frequently Asked Questions

How do I get a Screen ID?
What video formats are supported?
How does offline mode work?
Can I customize the player appearance?
How often does content refresh?
What are the keyboard shortcuts?
How do I monitor screen health?
Is an API key required?

Ready to Deploy Your Screens?

Download the SDK and get your digital signage running in minutes.