Roku Integration Guide
This guide explains how to integrate the StreamLayer SDK into a Roku Channel application built using BrightScript and SceneGraph.
Background
The StreamLayer Roku SDK enables you to enhance your Roku Channel with interactive overlays and viewer engagement features directly within the Roku environment.
Before proceeding, ensure that you are familiar with:
- StreamLayer Architecture Overview
- BrightScript Language Reference
- SceneGraph Concepts, including custom components and event observers
Prerequisites
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 to integrate StreamLayer into your application.
If you do not already have one, please follow the steps below:
- 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 3 months ago
