Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated as per DOCS-1280

Expand
titleTable of Contents
Table of Contents
minLevel1
maxLevel3
outlinefalse
indent20px
typelist
printablefalse

This page describes how to use two advanced BrightAuthor and BrightAuthor:connected features: custom autorun plugins and parser scripts. These instructions assume a certain level of familiarity with BrightScript. This is not a comprehensive guide to writing custom scripts for BrightAuthor or BrightAuthor:connected; rather, it is meant to provide a general outline and best practices for writing those scripts.

...

  • They can be easily inserted into multiple presentations, including newer and older versions of the same presentation.

  • They are not dependent on a certain autorun or firmware version, greatly reducing the complexity involved in updating custom BrightScript deployments.

BrightAuthor:connected Autorun Plugins

To designate one or more custom plugins in BrightAuthor:connected:

  1. If you are a Content Cloud user, upload your plugin to the server through the Content upload (see https://brightsign.atlassian.net/wiki/spaces/DOC/pages/384958989/Content#Scripts). If you are a Control Cloud user, skip directly to step 2 to add a plugin to the presentation.

  2. Attach it to your presentation (seehttps://brightsign.atlassian.net/wiki/spaces/DOC/pages/404623943/Presentation+Settings#Script-Plugin%5BinlineExtension%5D)

  3. If needed, refer to Plugin Message Eventto trigger state changes.

BrightAuthor Autorun Plugins

...

Plug-in scripts must include an initialization function in the form of <plugin_name>_Initialize(). This . Actions that take a lot of time should not be done in the initialization routine, because actions in the routine are synchronous. Instead, start a timer that will be caught by the plugin event handler soon after the routine runs, and execute the longer code segment there. For example, instead of unzipping a file in the initialization routine, do it through the plugin event handler with a timer started in the routine.

The initialization function is passed three parameters:

...