Boxee :: Wiki :: JavaScript API

Contents 1 JavaScript API 1.1 Class: boxee 1.1.1 Functions 1.1.2 Functions (User Definable) 1.1.2.1 Browser 1.1.2.2 Player 1.1.3 Variables 1.2 Class: Widget 1.2.1 Functions 1.2.2 Variables

JavaScript API

The Boxee JavaScript API is designed to facilitate interaction with media in the Boxee browser. Each time media is loaded, a set of JS control files that are stored on Boxee's remote server, are referenced. Each file represents an associated domain and specific to the player utilized on that domain. A list of known JS control files can be found below as examples of proper API usage:

Apple BBC CBS Comedy Central CNN Current TV Fancast FOX

FORA.tv Google Hulu Joost Metacafe MLB MTV MTV Music

MySpace NBA NBC Netflix PBS Revision3

South Park Studios TED The Onion The WB Vimeo Youtube

Anyone can write their own custom control files for an application. You can test your modifications by saving your domain.js file to the installed /boxee/system/players/flashplayer directory. This is not the boxee directory where your local profile data, log, and apps are stored. When you are sufficiently happy with the results, submit the controller to app-submit@boxee.tv where it will be reviewed and made available to every user in the Boxee community.

---

Class: boxee

Functions

• enableLog

void enableLog(bool enable)

Enable error/message logging.

• getActiveWidget

Widget getActiveWidget()

Returns the current active widget.

• getParam

string getParam(string param)

Returns any specific parameter for the widget.

• getVersion

float getVersion()

Returns the current boxee browser version.

• getWidgets

Widget getWidgets()

Returns a list of widgets (possible playable media) on the target webpage.

• log

void log(string msg)

Append a message to the boxee log.

• notifyCurrentTime

void notifyCurrentTime(int time)

Tell boxee the current time position in the media duration.

• notifyCurrentProgress

void notifyCurrentProgress(int percent)

Tell boxee what position the media is currently playing at.

• notifyPlaybackEnded

void notifyPlaybackEnded()

Tell boxee that the media has finished playing.

• runInBrowser

void runInBrowser(string javascript)

Pushes javascript code that can run in the browser. Useful for sending player commands.

• setCanPause

void setCanPause(bool can)

Enable user play/pause in the player window.

• setCanSetVolume

void setCanSetVolume(bool can)

Enable user volume control in the player window.

• setCanSkip

void setCanSkip(bool can)

Enable user skip next/prev in the player window.

• setDefaultCrop

void setDefaultCrop(int left?, int right?, int top?, int bottom?)

Sets the cropping for the media in the player window.

• setDuration

void setDuration(float dur)

Tell boxee how long the media is.

Functions (User Definable)

Browser

• onDocumentLoaded

void onDocumentLoaded = function()

As of Boxee 0.9.20 this method/callback seems to belong to the "boxee" class rather than "browser".

• onInit

void onInit = function()

• onNewWindow

void onNewWindow = function()

• rewriteSrc

string rewriteSrc = function(string source)

Player

• onBack

void onBack = function()

• onBigBack

void onBigBack = function()

• onBigSkip

void onBigSkip = function()

• onPause

void onPause = function()

• onPlay

void onPlay = function()

• onSetVolume

void onSetVolume = function(int volume)

• onSkip

void onSkip = function()

Variables

• autoChoosePlayer

bool autoChoosePlayer

Allow boxee to determine what media player to use when loading.

• browserHeight

int browserHeight

Force height of the boxee browser.

• browserWidth

int browserWidth

Force width of the boxee browser.

• renderBrowser

bool renderBrowser

Utilize the boxee browser to load the corresponding media.

---

Class: Widget

Functions

• click

void click(int x, int y)

Move the user's mouse to a pixel position and "clicks".

• getAttribute

string getAttribute(string attribute)

Returns any specific attributes for the widget.

• getPixel

int getPixel(int x, int y)

Returns pixel color information.

• mouseMove

void mouseMove(int x, int y)

Move the user's mouse to a pixel position.

• setActive

void setActive(bool active)

Enable the media widget.

Variables

• height

int height

Media widget height.

• width

int width

Media widget width.