BrightSign Object FW 5.1 User Manual
1
OBJECT REFERENCE MANUAL
`
Firmware Versions 5.1.x
BrightSign, LLC. 16780 Lark Ave., Suite B Los Gatos, CA 95032 | 408-852-9263 | www.brightsign.biz
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
roHtmlWidget ................................................................................................................................................................... 63
roImageBuffer .................................................................................................................................................................. 68
roImagePlayer ................................................................................................................................................................. 69
roImageWidget ................................................................................................................................................................ 74
roRectangle ..................................................................................................................................................................... 77
roShoutcastStream .......................................................................................................................................................... 78
roShoutcastStreamEvent ................................................................................................................................................. 79
roTextField ....................................................................................................................................................................... 80
roTextWidget ................................................................................................................................................................... 83
roVideoEvent, roAudioEvent ............................................................................................................................................ 88
roVideoInput .................................................................................................................................................................... 90
roVideoMode ................................................................................................................................................................... 93
roVideoPlayer .................................................................................................................................................................. 99
roTouchCalibrationEvent ............................................................................................................................................... 114
roTouchEvent ................................................................................................................................................................ 115
roTouchScreen .............................................................................................................................................................. 116
FILE OBJECTS ................................................................................................................. 122
roAppendFile ................................................................................................................................................................. 122
roCreateFile ................................................................................................................................................................... 124
roReadFile ..................................................................................................................................................................... 126
roReadWriteFile ............................................................................................................................................................. 128
HASHING AND STORAGE OBJECTS ............................................................................. 130
roBlockCipher ................................................................................................................................................................ 130
roBrightPackage ............................................................................................................................................................ 133
roDiskErrorEvent ........................................................................................................................................................... 136
roDiskMonitor ................................................................................................................................................................ 137
roHashGenerator ........................................................................................................................................................... 139
roPassKey ..................................................................................................................................................................... 140
roRegistry ...................................................................................................................................................................... 142
roRegistrySection .......................................................................................................................................................... 143
roSqliteDatabase ........................................................................................................................................................... 145
roSqliteEvent ................................................................................................................................................................. 148
roSqliteStatement .......................................................................................................................................................... 149
roStorageAttached, roStorageDetached ........................................................................................................................ 156
roStorageHotplug .......................................................................................................................................................... 158
roStorageInfo ................................................................................................................................................................. 160
CONTENT MANAGEMENT OBJECTS ............................................................................. 162
roAssetCollection ........................................................................................................................................................... 162
roAssetFetcher .............................................................................................................................................................. 165
roAssetFetcherEvent ..................................................................................................................................................... 169
roAssetFetcherProgressEvent ....................................................................................................................................... 174
roAssetPool ................................................................................................................................................................... 175
roAssetPoolFiles ............................................................................................................................................................ 177
roAssetRealizer ............................................................................................................................................................. 179
roAssetRealizerEvent .................................................................................................................................................... 181
roSyncSpec ................................................................................................................................................................... 183
NETWORKING OBJECTS ................................................................................................ 185
roDatagramSender, roDatagramReceiver, roDatagramSocket, roDatagramEvent ....................................................... 185
roHttpEvent .................................................................................................................................................................... 190
roHttpServer .................................................................................................................................................................. 192
roMediaServer ............................................................................................................................................................... 197
roMediaStreamer ........................................................................................................................................................... 199
roMediaStreamerEvent .................................................................................................................................................. 201
roMimeStream ............................................................................................................................................................... 202
roMimeStreamEvent ...................................................................................................................................................... 203
roNetworkAdvertisement ............................................................................................................................................... 204
roNetworkAttached, roNetworkDetached ....................................................................................................................... 206
roNetworkConfiguration ................................................................................................................................................. 207
roNetworkHotplug .......................................................................................................................................................... 216
roNetworkStatistics ........................................................................................................................................................ 217
roRssParser, roRssArticle ............................................................................................................................................. 219
roRtspStream ................................................................................................................................................................ 221
roShoutcastStream ........................................................................................................................................................ 222
roShoutcastStreamEvent ............................................................................................................................................... 223
roSnmpAgent ................................................................................................................................................................. 224
roSnmpEvent ................................................................................................................................................................. 225
roStreamByteEvent ....................................................................................................................................................... 227
roStreamConnectResultEvent ....................................................................................................................................... 228
roStreamEndEvent ........................................................................................................................................................ 229
roStreamLineEvent ........................................................................................................................................................ 230
roSyncManager ............................................................................................................................................................. 231
roSyncManagerEvent .................................................................................................................................................... 235
roTCPConnectEvent ...................................................................................................................................................... 236
roTCPServer .................................................................................................................................................................. 237
roTCPStream ................................................................................................................................................................. 238
roUrlStream ................................................................................................................................................................... 240
roUrlTransfer ................................................................................................................................................................. 241
roUrlEvent ...................................................................................................................................................................... 250
INPUT/OUTPUT OBJECTS ............................................................................................... 255
roCecInterface ............................................................................................................................................................... 255
roCecRxFrameEvent, roCecTxCompleteEvent ............................................................................................................. 256
roChannelManager ........................................................................................................................................................ 258
roControlPort ................................................................................................................................................................. 266
roControlUp, roControlDown ......................................................................................................................................... 272
roGpioControlPort, roGpioButton ................................................................................................................................... 273
roIRReceiver .................................................................................................................................................................. 275
roIRDownEvent, roIRRepeatEvent, roIRUpEvent .......................................................................................................... 277
roIRTransmitter .............................................................................................................................................................. 278
roIRRemote ................................................................................................................................................................... 279
roIRRemotePress .......................................................................................................................................................... 281
roKeyboard, roKeyboardPress ...................................................................................................................................... 283
roMessagePort .............................................................................................................................................................. 286
roSequenceMatcher ...................................................................................................................................................... 288
roSequenceMatchEvent ................................................................................................................................................ 291
roSerialPort .................................................................................................................................................................... 292
SYSTEM OBJECTS .......................................................................................................... 295
roDeviceInfo .................................................................................................................................................................. 295
roResourceManager ...................................................................................................................................................... 298
roSystemLog ................................................................................................................................................................. 300
DATE AND TIME OBJECTS ............................................................................................. 302
roDateTime .................................................................................................................................................................... 302
roSystemTime ............................................................................................................................................................... 304
roTimer .......................................................................................................................................................................... 309
roTimerEvent ................................................................................................................................................................. 313
roTimeSpan ................................................................................................................................................................... 314
LEGACY OBJECTS .......................................................................................................... 315
roRtspStreamEvent ....................................................................................................................................................... 315
roSyncPool .................................................................................................................................................................... 316
roSyncPoolEvent ........................................................................................................................................................... 319
roSyncPoolFiles ............................................................................................................................................................. 320
roSyncPoolProgressEvent ............................................................................................................................................. 321
Change Log ...................................................................................................................... 322
4.4.x, 4.2.x, 3.10.x ......................................................................................................................................................... 322
4.6.x, 4.4.x, 3.10.x ......................................................................................................................................................... 323
4.7.x ............................................................................................................................................................................... 324
4.8.x ............................................................................................................................................................................... 328
5.0.x ............................................................................................................................................................................... 330
5.1.x ............................................................................................................................................................................... 331
INTRODUCTION
BrightSign players use a standardized library of BrightScript objects to expose functionality for public software
development. To publish a new API for interacting with BrightSign hardware, we create a new BrightScript object.
This Object Reference Manual describes the BrightScript object architecture in two main sections:
• How to use BrightScript objects (as a script writer)
• How objects are defined for BrightSign players
1
Loading...