OBJECT REFERENCE MANUAL Firmware Versions 6.0.X
Total Page:16
File Type:pdf, Size:1020Kb
OBJECT REFERENCE MANUAL Firmware Versions 6.0.x BrightSign, LLC. 16780 Lark Ave., Suite B Los Gatos, CA 95032 | 408-852-9263 | www.brightsign.biz 1 TABLE OF CONTENTS INTRODUCTION ................................................................................................................ 1 INTERFACES AND METHODS OVERVIEW ..................................................................... 2 Classes .............................................................................................................................................................................. 3 Object and Class Name Syntax ......................................................................................................................................... 3 Zones................................................................................................................................................................................. 3 Event Loops ....................................................................................................................................................................... 4 BrightSign Object Library ................................................................................................................................................... 5 BRIGHTSCRIPT CORE OBJECTS .................................................................................... 6 roArray ............................................................................................................................................................................... 6 roAssociativeArray ............................................................................................................................................................. 8 roBoolean ........................................................................................................................................................................ 10 roByteArray ...................................................................................................................................................................... 11 roDouble, roIntrinsicDouble ............................................................................................................................................. 13 roFunction ........................................................................................................................................................................ 14 roGlobal ........................................................................................................................................................................... 15 roInt, roFloat, roString ...................................................................................................................................................... 23 roList ................................................................................................................................................................................ 27 roRegex ........................................................................................................................................................................... 30 roXMLElement ................................................................................................................................................................. 32 roXMLList ........................................................................................................................................................................ 36 PRESENTATION AND WIDGET OBJECTS .................................................................... 39 roAudioEventMx .............................................................................................................................................................. 39 roAudioOutput ................................................................................................................................................................. 40 roAudioPlayer .................................................................................................................................................................. 42 roAudioPlayerMx ............................................................................................................................................................. 49 roCanvasWidget .............................................................................................................................................................. 54 roClockWidget ................................................................................................................................................................. 60 roHdmiInputChanged, roHdmiOutputChanged ................................................................................................................ 64 roHtmlWidget ................................................................................................................................................................... 65 roImageBuffer .................................................................................................................................................................. 70 roImagePlayer ................................................................................................................................................................. 71 roImageWidget ................................................................................................................................................................ 80 roRectangle ..................................................................................................................................................................... 83 roShoutcastStream .......................................................................................................................................................... 84 roShoutcastStreamEvent ................................................................................................................................................. 85 roTextField ....................................................................................................................................................................... 86 roTextWidget ................................................................................................................................................................... 89 roVideoEvent, roAudioEvent ............................................................................................................................................ 94 roVideoInput .................................................................................................................................................................... 97 roVideoMode ................................................................................................................................................................. 100 roVideoPlayer ................................................................................................................................................................ 109 roTouchEvent, roTouchCalibrationEvent ....................................................................................................................... 128 roTouchScreen .............................................................................................................................................................. 130 FILE OBJECTS .............................................................................................................. 136 roAppendFile ................................................................................................................................................................. 136 roCreateFile ................................................................................................................................................................... 138 roReadFile ..................................................................................................................................................................... 140 roReadWriteFile ............................................................................................................................................................. 142 HASHING AND STORAGE OBJECTS .......................................................................... 144 roBlockCipher ................................................................................................................................................................ 144 roBrightPackage ............................................................................................................................................................ 147 roDiskErrorEvent ........................................................................................................................................................... 150 roDiskMonitor ................................................................................................................................................................ 151 roHashGenerator ........................................................................................................................................................... 153 roPassKey ..................................................................................................................................................................... 154 roRegistry