Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added hdmi reg. mark

...

...

...

...

...

...


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

Insert excerpt
BrightScript Version Navigation Menu
BrightScript Version Navigation Menu
nopaneltrue
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. 

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:

roVideoModeConfigures video output and interacts with displays using CEC/EDID.
roRectangleUsed to define zones/widgets on the screen. This object is passed to many other objects to define their screen area, including roVideoPlayerroImagePlayer, roImageWidgetroHtmlWidgetroClockWidget, and roCanvasWidget.
roVideoPlayerPlays video files, streams, and HDMI® input.
roImagePlayerDisplays images.
roHtmlWidgetDisplays local or remote HTML content using the Chromium rendering engine.
roNetworkConfigurationUsed to configure Ethernet, WiFi, and local network parameters.
roDeviceInfoUsed to retrieve a wide array of system information, including model type, device serial number, and firmware version.

...

Code Block
titleExample
p = CreateObject("roMessagePort")
video = CreateObject("roVideoPlayer") 
gpio = CreateObject("roControlPort", "BrightSign")
gpio.SetPort(p)
video.SetPort(p)  

...


The above syntax makes use of a shortcut provided by the language: The interface name is optional, unless it is needed to resolve name conflicts. For example, the following two lines of code carry out the exact same function:

Code Block
gpio.SetPort(p)
gpio.ifMessagePort.SetPort(p)

...


BrightScript Objects consist only of interfaces, and interfaces define only methods. There is no concept of a "property" or variable at the object or interface level. These must be implemented as "set" or "get" methods in an interface.

...