Roku SDK reference

Overview

This topic documents how to get started with the client-side Roku SDK, and links to reference information on all of the supported features. The Roku SDK is written in BrightScript.

Getting started

After you complete the Getting Started process, follow these instructions to start using the LaunchDarkly SDK in your Roku Application.

We provide releases on GitHub. Download the latest release and extract the provided files into your source tree. You may need to rename the paths inside LaunchDarklyTask.xml depending on your project structure.

For SceneGraph usage add a LaunchDarklyTask node to your scene.

To create a client instance, you need your environment's mobile key. This authorizes your application to connect to a particular environment within LaunchDarkly.

Here's how:

' get a reference to the task
launchDarklyNode = m.top.findNode("my-node-name")
' create configuration
config = LaunchDarklyConfig("mobile-key-123abc", launchDarklyNode)
' create a context
context = LaunchDarklyCreateContext({"key": "user-key-123abc", "kind": "user"})
' initialize the client
LaunchDarklySGInit(config, context)
COPY

To learn more about the specific configuration options available in this SDK, read Configuration.

For each SceneGraph component you want to use the SDK in you need to initialize an interface to talk to the SceneGraph. This interface provides all the expected client functionality, such as evaluation.

Here's how:

' create the scenegraph communication wrapper
launchDarkly = LaunchDarklySG(launchDarklyNode)
' use the client
value = launchDarkly.boolVariation("flag-key-123abc", false)
COPY

Creating a client outside of the SceneGraph API is similar. In the legacy API you do not need LaunchDarklySGInit or the LaunchDarklySG functions.

Here's how:

' get a reference to the task
launchDarklyNode = m.top.findNode("my-node-name")
' create configuration
config = LaunchDarklyConfig("mobile-key-123abc", launchDarklyNode)
' create a context
context = LaunchDarklyCreateContext({"key": "user-key-123abc", "kind": "user"})
' create message port
messagePort = createObject("roMessagePort")
' initialize the client
launchDarkly = LaunchDarkly(config, context, messagePort)
' use the client
value = launchDarkly.boolVariation("flag-key-123abc", false)
COPY

If not using the SceneGraph you need to poll events to drive the client in your standard event loop:

while (true)
    ' do not wait forever or timers will break
    msg = wait(3000, messagePort)
    if launchDarkly.handleMessage(msg) then
        ' this message was for the client
    else
        ' handle non client messages
    end if
end while
COPY

Supported features

This SDK supports the following features:

• Anonymous contexts and users
• Configuration, including
  • Application metadata configuration
  • Service endpoint configuration
• Evaluating flags
• Flag evaluation reasons
• Flushing events
• Getting all flags
• Identifying and changing contexts
• Logging configuration
• Monitoring SDK status
• Private attributes
• Relay Proxy configuration, using proxy mode
• Sending custom events
• Subscribing to flag changes
• User and context configuration