Joost Extension System

Overview

Welcome to the Joost Widget API Documentation. All that we expose and develop is simultaneously documented, so you can track the progress that we're making by reading this page.

Please note that the API may change and although we will try and keep these changes to a minimum, some API calls may be deprecated in the future.

Should you have any questions, please do not hesitate to ask.

Any and all use of the Joost API is subject to the Joost API Terms of Use

APIs

The following APIs are available in Joost:

XMLHttpRequest

By and large, this is the same API that you know well from within browsers; some restrictions have been added, while others have been loosened.

Runtime Engine Information

The Runtime Engine provides all manners of information about what the viewer is currently watching, as well as access to functionality such as seeking or switching channels. It is the API to the TV.

Global

The small set of miscellaneous methods added directly to the global Javascript context.

Joost

An object that exposes information specific to the user's current Joost installation (e.g. their name).

Preferences

The API for the storage and retrieval of permanent client-side settings.

Vocabularies

In addition to XHTML and SVG, the following XML vocabularies are available in Joost:

JWL (Jewel)

A small set of controls and parameters used to integrate widgets into Joost and to provide a more consistent UI.

Please note: JWL is being progressively phased out in favour of using pure XHTML+CSS. Some tips on what to use instead are in the JWL document.

Distribution & Packaging

Distribution and packaging of Joost widgets is described in the following documents:

JODA (Joost™ Open Distribution Archive)

JODA is the format into which the XML, Javascript, and other resources that compose a Joost Widget are packaged in order to be distributed and installed.