API Reference
Overview
This API Reference provides detailed information on all SDK methods and resources. The methods are organized by
Core SDK and Maestro Event Interface.
Core SDK
The Core SDK provides the fundamental methods and fields for initializing and configuring the Maestro Roku SDK. These methods and fields serve
as the entry point for integrating the SDK into your Roku application and allow you to configure behavior, manage event
lifecycles, and control the panel.
Configurable Fields
These fields are set by the client application to control SDK behavior:
| Field | Type | Description |
|---|---|---|
| config | assocArray | Primary configuration object; triggers Maestro config fetch |
| displayQRCodes | boolean | Enables/disables QR code display |
| fetchDataOnInit | boolean | Fetch panel data on load (default: true) |
| handleLoadingSceneAction | string | Communicates loading actions to your app |
| height | integer | Panel height; alias of panelManagerView.height |
| sendTestOverlay | string | "fantasy" or "bet" triggers an overlay test event |
| setDataToPanel | assocArray | Pushes external data into panel (depends on panel type) |
| userDidStartWatchingEvent | string | Used when user switches content; triggers new panel session |
| userSettings | assocArray | Override default panel/overlay/user behavior |
| width | integer | Panel width; alias of panelManagerView.width |
Public Functions
| Function | Description |
|---|---|
| destroySDK() | Clean teardown; removes all listeners |
| getDataFromPanel() | Returns panel data (polling model) |
| onPlayerTimeCodeUpdated() | Passes player timecode to SDK |
| setPanelFocus() | Moves Roku focus into the panel |
Maestro Event Interface
The Maestro Event Interface defines observable fields that your application can monitor to respond to SDK events and state changes. These fields allow you to track panel visibility, user interactions, and error conditions.
Panel Management
These fields allow you to monitor panel visibility and user interactions:
| Field | Type | Description |
|---|---|---|
| focusedTabItem | integer | Current tab index |
| onPanelEvent | assocArray | Panel-specific events |
| panelOpenedThroughOverlay | boolean | Special state: overlay → panel transition |
| shouldShowPanel | boolean | Panel visibility recommendation |
| userViewedPanel | assocArray | Emits panel name when opened |
State & Tracking
These fields allow you to monitor SDK state, errors, and analytics:
| Field | Type | Description |
|---|---|---|
| errorInformation | assocArray | Error reporting from SDK |
| trackingEvent | assocArray | Detailed analytics event stream |
| userRequestedLogin | boolean | User tapped "Login" button |
Client Action Fields
These fields allow your application to trigger actions in the SDK:
| Field | Type | Description |
|---|---|---|
| openToPanel | string | Open panel by name ("keyplays", "fantasy", "stats", etc.) |
| showPanel | boolean | Show/hide the Maestro panel |