| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
BrightSign players use a standardized library of BrightScript objects to expose functionality for software development. To publish a new API for interacting with BrightSign hardware, we create a new BrightScript object. Insert excerpt BrightScript Version Navigation Menu BrightScript Version Navigation Menu nopanel true
The pages in this section provide definitions for objects that can be used in BrightScript. A brief description, a list of interfaces, and the member functions of the interfaces are provided for each object class. While most BrightScript objects have self-contained pages, some objects are grouped on the same page if they are closely related or depend on one another for functionality.
Here is a sample of objects that are used frequently when creating applications in BrightScript:
| roVideoMode | Configures video output and interacts with displays using CEC/EDID. |
| roRectangle | Used to define zones/widgets on the screen. This object is passed to many other objects to define their screen area, including roVideoPlayer, roImagePlayer, roImageWidget, roHtmlWidget, roClockWidget, and roCanvasWidget. |
| roVideoPlayer | Plays video files, streams, and HDMI input. |
| roImagePlayer | Displays images. |
| roHtmlWidget | Displays local or remote HTML content using the Chromium rendering engine. |
| roNetworkConfiguration | Used to configure Ethernet, WiFi, and local network parameters. |
| roDeviceInfo | Used to retrieve a wide array of system information, including model type, device serial number, and firmware version. |
...
- An object of the type roMessagePort is created by the script.
- Objects that can send events (i.e. those that support the ifMessagePort/ifSetMessagePort interface) are instructed to send their events to this message port using the
SetPort()method. You can set up multiple message ports and have each event go to its own message port, but it is usually simpler to create one message port and have all the events sent to this one port. - The script waits for an event . The actual function to do this is ifMessagePort.WaitMessage(), but using the built-in in
Wait()statement in BrightScript allows you to do this more easily(or the ifMessagePort.WaitMessage() method). - If multiple object instances are assigned to the same message port, your the script should determine determines from which instance the event originated, then process processes it. The script then jumps back to the
Wait()statement.
...