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.

Get started

After you complete the Get started process, follow these instructions to start using the LaunchDarkly SDK in your Roku Application:

• Install the SDK
• Initialize the client
• (Optional) Initialize an interface to SceneGraph
• Evaluate a flag

Install the SDK

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.

Initialize the client

To create a client instance, you need your environment’s mobile key and the context for which you want to evaluate flags. This authorizes your application to connect to a particular environment within LaunchDarkly.

Here’s how to create the client:

1
' get a reference to the task
2
launchDarklyNode = m.top.findNode("my-node-name")
3
4
' create configuration
5
config = LaunchDarklyConfig("example-mobile-key", launchDarklyNode)
6
7
' create a context. You'll need this context later, but you can ignore it for now.
8
context = LaunchDarklyCreateContext({"key": "example-user-key", "kind": "user"})
9
10
' create message port
11
messagePort = createObject("roMessagePort")
12
13
' initialize the client
14
LaunchDarklySGInit(config, context)

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

Initialize an interface to SceneGraph

If you are working with SceneGraph, then for each SceneGraph component in which you want to use the Roku SDK, 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:

1
' create the scenegraph communication wrapper
2
launchDarkly = LaunchDarklySG(launchDarklyNode)

Evaluate a flag

After you initialize the client, you can use it to check which variation a particular context will receive for a feature flag.

Here’s how:

1
' use the client
2
value = launchDarkly.boolVariation("example-flag-key", false)

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

1
while (true)
2
3
    ' do not wait forever or timers will break
4
    msg = wait(3000, messagePort)
5
6
7
    if launchDarkly.handleMessage(msg) then
8
        ' this message was for the client
9
    else
10
        ' handle non client messages
11
    end if
12
end while

Supported features

This SDK supports the following features:

• Anonymous contexts and users
• Configuration, including
  • Application metadata configuration
  • Service endpoint configuration
• Context 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