BrightScript Objects Reference#

This section provides reference documentation for BrightScript objects available on BrightSign players.

Object Categories#

Media Playback#

User Interface#

Networking#

File System#

Hardware#

System#

Common Patterns#

Creating Objects#

' Basic object creation
player = CreateObject("roVideoPlayer")

' With parameters
serial = CreateObject("roSerialPort", 0, 9600)

' Validation
if type(player) <> "roVideoPlayer" then
    print "Failed to create video player"
    stop
end if

Event Handling#

Sub Main()
    msgPort = CreateObject("roMessagePort")

    player = CreateObject("roVideoPlayer")
    player.SetPort(msgPort)

    player.PlayFile("video.mp4")

    while true
        msg = wait(0, msgPort)
        if type(msg) = "roVideoEvent" then
            if msg.GetInt() = 8 then  ' MediaEnded
                print "Video finished"
            end if
        end if
    end while
End Sub

Full Documentation#

For complete object documentation, see the BrightSign API Reference.