Here you will find a rich set of resources for developers.

BrightScript and JavaScript APIs provide direct access to players.

APIs for accessing BSN.Cloud as well as the legacy BrightSign Network (BSN).

BrightSign players feature a full Chromium installation enabling players to display HTML content. Here you will find resources to help you develop HTML apps to run on our players.

The Diagnostic Web Server (DWS) enables access to player info and settings and offers tools for troubleshooting players. These APIs provide direct access to the DWS.

Similar to the JavaScript console in web browsers, the BrightScript Debugger is a powerful command-line tool for troubleshooting and debugging issues with BrightScript scripts or interacting with BrightScript objects.

The BrightSign Shell is a command-line interface (CLI) that enables interaction with the BrightSignOS (BOS). It can be used to troubleshoot and debug issues with the player as well as accessing things like network settings, display details, the BrightScript Interpreter, the BrightScript Debugger, a Node.js runtime, and player logs.


 contains additional resources for developers including plugins and custom scripts.

 batch file for Windows will generate MRSS manifest (.xml) files for a set of audio/video/image files. Note that:

 batch file for Windows will generate a Media List feed, which is a specially formatted RSS feed that can be used as a feed source for these states:

Developers

This is our legacy cloud platform. Our latest cloud platform is BSN.Cloud which consists of the free bsn.Control and the paid bsn.Content tiers. Development of BSN has largely ceased and will eventually be deprecated and replaced with BSN.Cloud.

BrightSign_Network_BSN

BrightSign’s *legacy* app for authoring and managing players. The app's actual name is BrightAuthor but is referred to as BrightAuthor Classic to lessen confusion with BrightAuthor:connected, our latest app.

BrightAuthor_Classic

BrightSign’s latest free, all-in-one app for player setup / management, authoring, and content management.

BrightAuthorconnected

The BSN.Cloud record of a player and its Setup. The Default Setup is assigned to the player unless another Setup has been explicitly set.

Provision_Record

The process where a Setup is delivered and applied to a player by BSN.Cloud.

Provision

A set of files containing player settings (player name, description, time zone, Publishing Mode, network settings, etc.) and an autorun.brs file which instructs the player what to do upon bootup.

Setup

BrightScript Debug Console

BrightScript Encryption

BrightScript Known Issues

BrightScript Versions

Built-In Functions

Core Library Extension

Events

Example Script

Garbage Collection

Intrinsic Objects

Objects and Interfaces

Operators

Program Statements

Reserved Words

Scope

Threading Model

Variables, Literals, and Types

XML Support

Language Reference

Global Functions

BrightScript Core Objects

Presentation and Widget Objects

File Objects

Hashing and Storage Objects

Content Management Objects

Networking Objects

Input/Output Objects

Date and Time Objects

System Objects

Legacy Objects

Object Reference

BrightScript

Enabling BrightScript-JavaScript Objects

BSBtManager

BSCECReceiver

BSCECTransmitter

BSControlPort

BSDatagramSocket

BSDeviceInfo

BSIRReceiver

BSIRTransmitter

BSMessagePort

BSSerialPort

BSSyncManager

BSTicker

BSVideoMode

Global BrightScript-JavaScript Functions

BrightScript-JavaScript Objects

BrightScript-JavaScript Migration Guide

JavaScript Event Handling

BrightSign Asset Pool Example

BrightSign Asset Pool

assetfetcher

assetpool

assetpoolfiles

assetrealizer

audio

audioconfig

audiooutput

chardisplay

compositor

configurednetworks

controlport

cookiestore

decoderconfiguration

devicecustomization

deviceinfo

devicestatus

dwsconfiguration

filesysteminfile

filesysteminfo

hostconfiguration

htmlwidget

keyboard

keystore

messageport

networkconfiguration

networkdiagnostics

networkhotplug

networkstatus

openvpn

pointer

pointercalibration

registry

resolver

screenshot

securestore

serialport

serialportlist

storage

storageinfo

syncmanager

system

systemtime

tvcontroller

usbfilesystem

usbhidemulator

usbhotplug

usbpowercontrol

videoinput

videomodeconfiguration

videooutput

JavaScript APIs

Player APIs (BrightScript & JavaScript)

Version 2.0 B-Deploy Endpoints

Version 3.0 B-Deploy Endpoints

B-Deploy/Provisioning APIs

2025 API Usage Guide

Breaking Changes & Version Updates

General Information

Main API version 2022/06

Main API version 2020/10

BSN.Cloud Main APIs

bsn.Control API Integration Guide

Postman Collections

Cloud APIs

Displaying HTML with BrightAuthor:connected

Displaying HTML without BrightAuthor (Connected or  Classic)

How to Efficiently Restart Applications on a Player

HTML Authoring Resources

Animations and Add-on Libraries

BrightSign Extensions

Creating HTML Pages

Debugging Webpages

Disabling Staged ES6 Features

HTML Caching

HTML Content Restrictions

HTML Storage

Renderer Versions and Support

Touchscreen Support

Using HTML Websites that Require Logins

HTML Best Practices

HTML Playback Options on Series 5 Players

HTML Video

Known Issues

Node.js

Node.js Versions

HTML Development

LDWS Advanced Endpoints

LDWS Control Endpoints

LDWS Diagnostics Endpoints

LDWS Display Control Endpoints

LDWS General Endpoints

LDWS Info Endpoints

LDWS Logs Endpoints

LDWS Registry Endpoints

LDWS Remote Snapshot Endpoint

LDWS sendCecX Endpoint

LDWS Storage Endpoints

LDWS Video Endpoints

Local DWS APIs

rDWS Control Endpoints

rDWS Diagnostics Endpoints

rDWS Display Control Endpoints

rDWS Files Endpoints

rDWS Information Endpoints

rDWS Logs Endpoints

rDWS Other Endpoints

rDWS Registry Endpoints

rDWS Remoteview Endpoints

rDWS Video Endpoints

Remote DWS APIs

Diagnostic Web Server APIs

IGMP Behavior

BrightSign Registry Keys

BrightScript Debugger

BrightSign Shell