Applying Settings in the Property Sheet (DOCS-737)

Overview

BrightSign’s OS version 8.2.72 and BrightAuthor:connected version 1.6.29 contain a new feature that lets users see and modify settings using the BSN.cloud Properties Panel or through the BSN.cloud API. To avoid backwards compatibility issues, the supervisor won't honor these settings unless it is first enabled in your custom Device Setup Package, custom presentation, or custom application/plugin.

This feature is natively supported and enabled in BrightAuthor:connected presentations using version 1.6.29 or later, but you must enable it if you are running custom scripts. This document describes how to enable this feature.

Pre-Requisites

You must be using BSN.cloud
Minimum BrightAuthor:connected version: 1.6.29
Minimum OS version: OS 8.2.72

ON THIS PAGE

Implementing the Settings Handler

To enable the Settings Handler from a custom Device Setup Package (not downloaded from BrightAuthor:connected):

Include the autorun-setup.brs code snippet in your Device Setup Package (see the example below).
In BrightAuthor:connected, navigate to the player’s “Network” (under the top right dropdown). The player settings are accessible in the Properties panel of BrightAuthor:connected (under the Network tab).
Note: The script type would be "Setup" if the “setup script” comment in autorun-setup.brs is initialized as “setup” in order to support settings being applied from BrightAuthor:connected after the setup process is completed. The setup process is completed after the success splash screen is displayed on the player’s video HDMI output.

To enable the Settings Handler from a custom presentation or custom application/plugin, include the either the autorun-custom.brs code snippet to your custom application/plugin/presentation or attach the plugin autorun-plugin-enableSettingsHandler.brs to the presentation

Once the device-side API is turned on, the player settings will be accessible in the Properties panel of BrightAuthor:connected (under the Network tab).