Roku SDK Overview & Prerequisites
Get your environment ready to work with the StreamLayer Roku SDK. This page covers system requirements, API key setup, and what you need before moving to integration.
Background
StreamLayer Roku SDK provides a Roku SDK that brings interactive overlays, real-time engagement features, and pause ads into your Roku Channel. The SDK is built on BrightScript and runs within the Roku SceneGraph framework.
Before you begin, make sure you're familiar with:
- StreamLayer Architecture Overview
- BrightScript Language Reference
- SceneGraph Concepts, including custom components and event observers
System Requirements
- Roku OS 11.5 or later
- Roku SceneGraph application framework
- Developer mode enabled on your Roku device
- Access to the Roku Developer Dashboard
- Familiarity with SceneGraph concepts, including custom components and event observers
If your system does not meet these requirements, contact the StreamLayer development team to verify compatibility.
Obtain an SDK API Key
You will need an SDK API Key before you can initialize the SDK. If you don't have one yet:
- Provide your email address to the StreamLayer team. This will allow us to create a new organization for you on our platform and set up a personal dashboard for your account.
- You will receive an invitation email containing a link to the StreamLayer Admin Panel and your authentication credentials.
- After gaining access to the Admin Panel, navigate to the Development section to generate your API key.
Tip: This API key authenticates your application with StreamLayer servers and is required for all SDK interactions.
Updated 15 days ago