Example Portal Overview

The example portal, showing a video of the ARRIS racing team

Introduction

The KreaTV SDK includes an example portal designed to illustrate how the TOI API works. The example code implements a simple TV viewing application, with volume control, channel zapping, audio track and language selection and a few other features. It is designed to be easy to read and understand, and should help you get started with using TOI.

File layout

The example portal is distributed as HTML and JavaScript files in the KreaTV SDK. After installing the SDK you should see the following directory structure in <sdk_root>/examples/portal

├── index.css
├── index.html
├── index.js
└── modules
    ├── audio
    ├── keyboard
    ├── menu
    └── popup

Some framework.* files are also present. These implement the example portal UI. It is not necessary to dig into these. The point of the example is to illustrate how to work with TOI, not how to write a portal, so the UI code has been hidden in these framework files when possible. UI related code is also removed from the code extracts presented in the documentation.

Modules

Each module demonstrates how to accomplish a specific task with the TOI API.

Disclaimer

This portal is written to be easy to read. It often performs tasks in a less than optimal way, for the sake of clear readability. Most of the TOI function calls can throw exceptions, which are rarely handled in this example code. Obviously in production-quality code you should always check for and handle exceptions! Please keep this in mind when developing your own applications/portals.