system

The system object provides functions related to the system software.

system IDL

interface System {
    void reboot();
    void factoryReset();
    void rebootWithCrashReport();
    Promise<void> setImageSizeThreshold(Size size);
};

interface Size {
    attribute int width;
    attribute int height;
};

Object Creation

To create a system object, first load the brightsign/system module using the require() method. Then create an instance of the system class.

var systemClass = require("@brightsign/system");
var system = new systemClass();

System

Use this interface to call system-software methods.

reboot()

void reboot()

Instructs the player to perform a soft reboot.

factoryReset()

Instructs the player to perform a factory reset.

rebootWithCrashReport()

Instructs the player to perform a reboot with a crash report.

suspend()

Puts the player into low power mode, if it is supported on the platform. The player will turn off peripherals and most of the core functionality to save power. It can be woken up with RST, SVC button, or other platform-dependent wake up sources(RTC, Wake-On-Lan etc.). Available as of BOS 9.0.168.

setImageSizeThreshold()

Changes the maximum allowed resolution for images. This method accepts a Size interface specifying the new allowed resolution.

The default image resolution limit is 2048x1280x32bpp (or 4096x2160x32bpp for XTx44, XTx43, XDx34, XDx33, 4Kx42 players). Displaying images larger than the default value may deplete the graphics memory and cause a crash, so we recommend testing a script that uses this method thoroughly before deploying it in a production environment.

Tip

Without altering the default maximum resolution, you can increase the maximum width of images by sacrificing height (e.g. using a 4096x640x32bpp image on non-4K-capable players is allowed). You can also increase the maximum width/height by reducing the bpp value (e.g. using a 4096x1280x16bpp on non-4K-capable players is allowed).

Size

This interface describes the dimensions of an image.

width int: The width of the image
height int: The height of the image

Documentation