User Tools

Site Tools


build

Building Projekktor from Source

General

Once you downloaded the player´s source you will find the script separated into multiple files. In order to get the un-compressed and un-merged Javascript running you need to include the mentioned files one by one to your development page or merge them into a single file. The most important trick is:

Including / merging ALL files will fail. Also be aware that projekktor.js MUST BE INCLUDED FIRST - after jQuery of course.

Directory Structure

The /js path of the repository holds four sub-directories:

  • jQuery - Includes one or more incarnations of jQuery for testing purposes.
  • controller - Holds the player´s core controller, models and basic tools.
  • models - Holds, well, the playback models.
  • plugins - Holds (not so) optional plugins.
  • parsers - Some custom reel parser functions needed to convert incoming feed into the Projekktor playlist format. (coming up)

The Controller and Tools

Projekktor´s controller is generated out of all /js/controller/projekktor.*.js files. Each of the following files is strictly obligatory. It´s vital to load projekktor.js first.

  • projekktor.js - The player´s controller itself.
  • projekktor.config.js - The default configuration object with all available config parameters.
  • projekktor.utils.js - A set of more or less useful utility-functions used within the player.
  • projekktor.plugininterface.js - A basic plugin-prototype all plugins are extended from.

The Models

The player models handle the content-playout itself. Some of them are obligatory, some are optional and some will replace other ones depending on the setup.

  • player.js - The model prototype - obligatory
  • player.NA.js - “Invalid File” dummdy model - obligatory
  • player.playlist.js - Allows to load a playlist from within a playlist - optional
  • player.audio.video.js - Native audio / video support - optional
  • player.audio.video.flash.js - Flash audio / video support featuring Jarisplayer - optional
  • player.jwflash.js - Flash audio / video support featuring JWplayer - replaces “player.audio.video.flash.js” - optional
  • player.youtube.js - Youtube API support - optional
  • player.image.html.js - Displays images and HTML pages as regular content - optional

The Default Plugins

  • projekktor.display.js - holds the video / poster / image screen as well as the start button, the buffer icon and the logo. Not including this will make an extremely boring video player.
  • projekktor.controlbar.js - the custom control bar

The Parsers

(coming up)

build.txt · Last modified: 2013/03/06 00:38 by operator