Using a Template for Roku Springboard Screens

Springboard Templates may only be used in Roku apps at Update #520 or later.

A Springboard Template allows you to make changes in a single video item, and have those changes appear in all video items within the app. Currently, Springboard Templates only affect Springboard button parameters.

Using a Template also allows older video items that do not support newer buttons to inherit newer buttons from the Template, instead of having to recreate the video item from scratch.

In order to use a Springboard Template, you must also be able to add, remove, and modify Springboard buttons. To do this, you'll need to set your Instant TV Channel Show More Options to "Full" and enable Springboard button editing.

Enable Springboard Button Editing

  1. Click the Account link on the left side of the page to go to your Account page.

  2. On your Account page, change Show More Options to "Full - Show all settings". This will cause the advanced parameters, which were previously hidden, to be displayed on all Instant TV Channel pages.
  3. Change Show Custom Springboard Buttons to "Yes - Springboard Buttons Can Be Edited".
  4. Click the green SAVE CHANGES button at the top of the page.
  5. After enabling Springboard button editing, you will see previously hidden Button parameters for each video content item.

  6. On the Content page, create a new video item at the top level of the content tree, for example directly below the top-most yellow folder. This video item will be the Template.
  7. Change the Template's DoNotDisplay parameter to "yes". This prevents the Template from being displayed as a video item. This is recommended, but not required.
  8. Modify the buttons in the Template to suit your requirements. Possible button modifications are:
    • Remove a button from the Springboard. This is done by clicking Delete on the button that you wish to remove.
    • Add a new button to the Springboard. This is done by clicking New on the bottom button in the list of buttons. The newly added button will appear at the bottom of the list. The new button's Action parameter is initially set to "New", which must be changed to any of the other available Action choices.
    • Change a button's action. This is done by changing a button's Action parameter. Depending on a button's Action parameter, various other parameters may be available to configure the button's behavior.
    • Change the on-screen button text. This is done by editing a button's Label parameter. This can also be done globally (to all similar buttons in the app) using a Theme button label parameter, but only if the button's Label parameter in the video item still has its original value.
    • Change the order of the buttons on the Springboard. This is done by clicking the up and down arrows for each button that you want to move.

Final Step: Enable the Springboard Template

  1. Click the Theme link on the left side of the page to enter the Theme Editor.
  2. Locate the SpringboardTemplateEnabled parameter and change it to "yes".

If the Springboard Template is enabled:

  • The Springboard buttons in the template video will be duplicated on-screen for all other video items in the app.
  • Any changes made to the Template video's Button parameters will apply to all other video items in the app.
  • The Button parameters of individual non-Template video items are ignored, except for the video chosen in a video item's own Trailer and GoTo buttons, as described below.
  • It is not necessary to re-package the app after making changes to the Template.

Trailer and GoTo buttons with a Springboard Template

The Template decides which Trailer and GoTo buttons appear and how they look: their label, when they are displayed, whether ads play, and their position. A video item can only choose the video those buttons play. If a video item's own Trailer button has a video chosen in its Trailer Name, the Template's Trailer button plays that video instead of the Template's video. GoTo buttons work the same way, using the video item's GoTo Name. A video item's own Trailer and GoTo buttons never add, remove, move, or relabel a button.

A button has a video chosen when a content item has been dragged onto its Trailer Name (or GoTo Name).

Trailer buttons when the Springboard Template is enabled (GoTo buttons work the same way)
Video item has
   Template has
   What the viewer sees
A Trailer button with a video chosen A Trailer button with a video chosen The Template's Trailer button, playing the video item's own video
A Trailer button with a video chosen A Trailer button with no video chosen The Template's Trailer button, playing the video item's own video
A Trailer button with a video chosen No Trailer button No Trailer button
A Trailer button with no video chosen A Trailer button with a video chosen The Template's Trailer button, playing the Template's video
A Trailer button with no video chosen A Trailer button with no video chosen No Trailer button
A Trailer button with no video chosen No Trailer button No Trailer button
No Trailer button A Trailer button with a video chosen The Template's Trailer button, playing the Template's video
No Trailer button A Trailer button with no video chosen No Trailer button
No Trailer button No Trailer button No Trailer button

More than one Trailer button: If the Template has more than one Trailer button, the videos chosen in the video item's own Trailer buttons are used in order: the first video goes into the Template's first Trailer button, the second into the second, and so on. Extra videos in the video item are ignored. Extra Template Trailer buttons play their own video, or are not displayed if they have none. GoTo buttons work the same way.

When the Springboard Template is not enabled, every video item uses its own buttons.



Want to know how to make a Roku app in 5 minutes? Check out this Instant TV Channel Walk-Through!

 

Instant TV Channel is a cloud-based tool for Roku developers and content providers that shortens development time and eases maintenance after deployment.


Subtitles

If you are considering subtitles for your Roku video content, Instant Subtitles provides an easy-to-use and inexpensive solution. Click here for more information.




Access Code: ID1
Check out Instant TV Channel by adding our latest demonstration app to your Roku player.



Instant TV Channel is not affiliated with nor endorsed by Roku Inc.