Skip to content

Latest commit

 

History

History
 
 

SGDEX Development Guide

The guide covers some key concepts of Roku Scene Graph development using library which streamlines the process and makes it quicker that conform to the Roku UX guidelines.

This guide is composed of the following sections:

  1. SGDEX Guide: Setup and HelloWorld

    The section describes how to:

    • set up the working environment (IDE, ROKU plugin)
    • set up the file structure for a channel
    • set up a manifest file
    • import the library into the channel
    • create an entry scene
    • observe the result
  2. SGDEX Sample: Basic Channel

    The section describes how to:

    • set up the working environment (IDE, ROKU plugin)
    • import the library into the channel
    • create, initialize and setup grid view component
    • parse a content feed
    • create, initialize and setup details view component
    • create video component and implement its logic
    • create, initialize and setup episode picker component
  3. SGDEX Guide: Grid

    The section describes how to:

    • create and initialize grid view component
    • set up content handler
    • fetch content for grid view
  4. SGDEX Guide: DetailsView

    The section describes how to:

    • create and initialize details view component
    • set up content handler
    • fetch content for details view
    • implement function that updates the information contextually based on the type of content
    • attach handler in order to open details view from the grid view
  5. SGDEX Guide: Video The section describes how to:

    • create media view component
    • implement logic for video content
    • open video player
  6. SGDEX Guide: Endcards

    The section describes how to:

    • create endcard component
    • set up endcard content handler
    • triggering the endcard
  7. SGDEX Guide: EpisodePickerView

    The section describes how to:

    • create and configure episode picker view component
    • override function for getting content
    • implement functionality to display selected episode
  8. SGDEX Guide: Custom View

    The section describes how to create and invoke custom view that displays thumbnail full screen

  9. SGDEX Guide: Bookmarks

    The section describes how to:

    • modify details view logic in order to add and correctly refresh bookmarks
    • save bookmarks in run-time on user navigation, using timed interval and between sessions
  10. Roku Recommends Sample channel using Roku Recommends feed to populate content. Feed is in XML format so custom parser is used in ContentHandler.

  11. Decoupled Grid ContentManager Sample channel using native RSG view to populate content. Feed is stored in API, so custom parser is used in ContentHandler and populate on custom RSG view.

  12. Decoupled TimeGrid ContentManager Sample channel using custom TimeGrid based native RSG view with the SGDEX ContentManager. Feed is stored in API, so custom parser is used in ContentHandler and populate on custom RSG view.