API Reference#

Complete reference documentation for BrightScript objects, JavaScript APIs, and BSN.cloud REST APIs.

Reference Sections#

BrightScript Objects #

Core BrightScript objects for media, networking, storage, and hardware.

JavaScript APIs #

JavaScript APIs available in HTML widgets and Node.js applications.

BSN.cloud API #

REST API reference for BSN.cloud device and content management.

Local DWS API #

Diagnostic Web Server API for local device control.

Quick Reference#

Core Objects#

Object	Purpose
`roVideoPlayer`	Video playback
`roAudioPlayer`	Audio playback
`roImagePlayer`	Image display
`roHtmlWidget`	HTML content
`roUrlTransfer`	HTTP client
`roMessagePort`	Event handling
`roTimer`	Timed events

Common Operations#

' Create objects
player = CreateObject("roVideoPlayer")
xfer = CreateObject("roUrlTransfer")

' Set up events
msgPort = CreateObject("roMessagePort")
player.SetPort(msgPort)

' Wait for events
msg = wait(0, msgPort)

API Versions#

BrightScript: Available on all firmware versions
JavaScript: Requires HTML5 widget support
BSN.cloud API: Version 2022/06 (current)
Local DWS: Requires DWS enabled on player