Roku BrightSign Manual

Roku Object Reference Matches HD2000 Software Version: 2.0.94 California, USA www.roku.com/brightsign1

roMessagePort A message port is the place messages (events) are sent. See the “Event Loops” section for more details. When using Roku BrightScript,

roVideoMode This class allows you to set the output video resolution. The same video resolution is applied to all video outputs on BrightSign. Vide

GetResX, GetResY (HD2000 only currently) Get the total display size for the current video mode. GetSafeX, GetSafeY (HD2000 only currently) Get the

roVideoPlayer A Video Player is used to play back video files (using the generic ifMediaTransport Interface). If the message port is set, the object

Users can add events which trigger messages of the roVideoEvent “Timecode Hit” at the specified millisecond times in a video file. The data field of

roAudioPlayer An audio player is used to play back audio files (using the generic ifMediaTransport Interface). If the message port is set, the objec

1 - Stereo audio is mapped to AUDIO-2 2 - Stereo audio is mapped to AUDIO-1 set_volume Volume is a percentage and so takes a value 0-100. Th

Only a single file can be sent to an output at any given time. For example, two roAudioPlayers cannot simultaneously play to the SPDIF output - the se

video.SetAudioStream(0) video.SetAudioOutput(3) video.SetAudioStreamAux(1) video.SetAudioOutputAux(0) video.PlayFile("TwoStreams.m

roVideoEvent() and roAudioEvent() Video and Audio events can have one of these integer values. They are declared as separate classes as they are like

2 4455556778810111213151920202121222223232426283132333334353638404243444546485053Table of Contents INTRODUCTION ...

roGpioControlPort This object is used to control and wait for events on the BrightSign generic DB25 control port and front panel. Typically LEDs or

roQuadravoxSNS5 This object is used to control and wait for events on the Quadravox SNS5 serial button/LED box. Interfaces:  ifSetMessagePort rotVO

roKeyboard This object is used to wait for events from a USB keyboard. Interfaces:  ifSetMessagePort rotVOID SetPort(rotOBJECT) roKeyboardPress A

roIRRemote The key code from Roku’s custom code using the NEC protocol is decoded and sent as an event. Use this object to register your Event port

roImagePlayer Display static bitmap images on the video display. Interfaces:  ifImageControl rotBOOL DisplayFile(rotSTRING image_filename) rotBOO

 10 to 11 - Venetian blinds vertical and horizontal  12 to 13 - Comb effect vertical and horizontal  14 - Fade out to background color then back

roInt, roFloat, roString The intrinsic types rotINT32, rotFLOAT, and rotSTRING have an object and interface equivalent. These are useful in the foll

BrightScript> l=ListDir("/") BrightScript> for i=1 to l.Count():print l.RemoveHead():next test_movie_3.vob test_movie_4.vob test_movie

roTouchScreen The touch screen object allows you accept events from touch screen panels or Mice. Currently only the Elo USB touch screens or a USB M

3. ifEvent (mouse events). ifEvent has the following member function: a. rotINT32 GetEvent() EnableRollover: Use this function to enable a rollove

roNetworkConfiguration (HD2000 only)... 54555658roStorageInfo

t.SetPort(p) REM Puts up a cursor if a mouse is attached REM The cursor must be a 16 x 16 BMP REM The x,y position is the “hot spot” point t.SetCursor

roSerialPort This object controls the RS232 serial port, allowing you to receive input and send responses. roSerialPort has these interfaces: 1. if

roDeviceInfo The roDeviceInfo object implements the ifDeviceInfo interface only. The ifDeviceInfo interface provides:  rotSTRING GetModel(rotVOID)

roRegistry (HD2000 only) The registry is an area of memory where a small number of persistent settings can be stored. Access to the registry is availa

roSystemTime (HD2000 only) roSystemTime provides the ability to read and write the time stored in the RTC This object supports getting and setting the

SST: X-ray Time Zone (Pago Pago) GMT: Greenwich Mean Time GMT-1: 1 hour ahead of Greenwich Mean Time GMT-2: 2 hours ahead of Greenwich Mean Time GMT-3

 rotVOID SubtractSeconds(rotINT32 seconds)  rotVOID AddMilliseconds(rotINT32 milliseconds)  rotVOID SubtractMilliseconds(rotINT32 milliseconds)

timer.Start() else print "unexpected event received" endif endwhile Example: This code creates a timer that triggers every mi

roReadFile, roCreateFile, roReadWriteFile, roAppendFile (HD2000only) These objects provide file I/O functionality on the HD2000 using the ifStreamRea

 rotVOID SendBlock(rotSTRING string) o Writes the specified characters to the stream. Any null bytes will terminate the block. The ifStreamSeek int

Introduction Roku Objects (RO) are the standardized way Roku software exposes functionality for our products’ public SDKs. In other words, to publi

roTextField (HD2000 only) A text field represents an area of the screen that can contain arbitrary text. This feature is intended for presenting diagn

o rotVOID SetSendEol(rotSTRING string) o Set the sequence sent at the end of a SendLine request. This should be left at the default value of chr(13)

roAssociativeArray (HD2000 only) An associative array (also knows as a map, dictionary or hash table) allows objects to be associated with string keys

roRectangle (HD2000 only) This object is created with several parameters:  CreateObject("roRectangle", rotINT32 x, rotINT32 y, rotINT32 wi

roTextWidget (HD2000 only) An object used for putting text on the screen. Object creation:  CreateObject("roTextWidget", roRectangle r, r

roResourceManager (HD2000 only) The roResourceManager is used for managing strings in multiple languages. Object creation:  CreateObject("roRe

roClockWidget (HD2000 only) roClockWidget puts a clock on the screen. It has no extra interface, only construction arguments. roClockWidget implement

// %y Two digit year // %Y Four digit year // Time format // // %H The hour using 24-hour clock (00 to 23) // %I The hour using 12-hour clock (01 t

roUrlTransfer (HD2000 only) This object is used for reading from and writing to remote servers through URLs. This object is created with no parameter

 rotBOOL AsyncPostFromString(rotSTRING request) o Use the HTTP POST method to post the supplied string to the current URL. Events of type roUrlEven

interface would contain only the new methods. The “old” method still exists in the original Interface. Older applications will only use the original

roUrlEvent (HD2000 only)  rotINT32 GetInt(rotVOID) o Returns the type of event. The following event types are currently defined:  1 – transfer c

-31 _REST CURLE_FTP_COULDNT_USE the REST command failed -33 CURLE_RANGE_ERROR RANGE "command" didn't work -34 CURLE_HTTP_POST_ERROR

-75 CURLE_CONV_FAILED conversion failed -76 caller must register conversion callbacks using curl_easy_setopt options CURLOPT_CONCURLE_CONV_REQD V_F

roRssParser, roRssArticle (HD2000 only) roRssParser and roRssArticle class are used to display an RSS ticker on the screen. roRssParser is created w

roNetworkConfiguration (HD2000 only) Object creation:  CreateObject("roNetworkConfiguration", 0) The ifNetworkConfiguration interface pr

roStorageInfo (HD2000 only) Objects of this type are used to report storage device usage information. Object creation:  CreateObject("roStorag

roBrightPackage (HD2000 only) An roBrightPackage represents a zip file. The zip file can include arbitrary content or can be installed on a storage de

t.PushString("Update complete - remove USB drive to restart.") wait: sleep(1000) usb_key = CreateObject("roReadFile", "US

roDatagramSender, roDatagramReceiver (HD2000 only) The roDatagramSender and roDatagramReceiver classes allow for simple sending and receiving of unica

59

Zones (HD2000 only) With the BrightSign Zones feature, you can divide the screen into rectangles and play different content in each rectangle. A zon

i3.DisplayFile("museum_ad2.jpg") endif r=CreateObject("roRectangle", 1520, 50, 300, 100) res=CreateObject("roResourceMan

By convention, Roku Object (RO) events work as follows.  A RO of type “roMessagePort” is created. In BrightScript, by the user’s script.  ROs

rotOBJECT RemoveTail(rotVOID) rotOBJECT RemoveHead(rotVOID) rotOBJECT GetTail(rotVOID) rotOBJECT GetHead(rotVOID) 9