Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 2.95 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.95 KB
Raw

 

boxcast-sdk-roku

The BoxCast SDK for Roku video playback allows you to develop your own Roku applications to watch content from your BoxCast account.

This repository provides an entire sample application, built with a combination of the following Roku technologies:

  • BrightScript utilities for querying data from your account and tracking viewer analytics
  • SGDEX components that can be extended to customize your viewer's experience

Installation

git clone https://github.com/boxcast/boxcast-sdk-roku.git

Usage

Edit the source/BoxCastConfig.brs to match your settings. The most important fields that must be filled in are your Account ID and Channel ID, which can be found on your Dashboard Settings.

this = {
  ...

  Account: {
    id:         ' TODO: fill in from dashboard '
    channel_id: ' TODO: fill in from dashboard '
  }

  ...
}

Then follow standard Roku Development practices. Note that there is a Makefile that includes a make install script for easily bundling and installing your application on your Roku device, provided that you set up an environment variable for ROKU_DEV_TARGET and DEVPASSWORD.

Before publishing, make sure to also update the manifest and Makefile with your app name and settings, as well as configuring your own images.

Known Limitations

  • This SDK is for viewing and querying of broadcasts on accounts that do not protect their content with pay-per-view ticketing, host restrictions, geoblocking, passwords, or other authentication means. The BoxCast API will reject requests for such content, so you should be prepared to handle errors.

SGDEX License

SceneGraph Developer Extensions (SGDEX) and associated documentation files (the "Software") are Copyright (c) 2019 Roku, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.