V5 Plugin Model Proposal

This page describes the proposal for managing v5 plugins.

Distribution

All plugins will be distributed through a hybrid model:

  • hosted
  • for download

The hosted model will be the default (big button) and the for download model will be the alternative (small button). Additionally, we'll add an explanation that explains the pros and cons of both methods:

  • hosted plugins are automatically updated
  • hosted plugins have all crossdomain fixed already
  • hosted plugins have short embed codes
  • downloaded plugins work offline or behind firewalls
  • downloaded plugins can be tweaked and and recompiled

The hybrid model offers most flexibility, since it can also be used for all other addon types:

  • modules
  • javascripts (new category?)
  • skins
  • models (CDN plugins - new category?)

As we move forward towards a Silverlight / HTML5 version of our player, more plugin / addon types will appear.

Security

Only licensed plugins will feature a security mechanism. This will be a phone-home mechanism that checks for:

  • The license key (precompiled or through a flashvar)
  • The player domain
  • The license expiration date

Note that this mechanism is independent from the distribution method (hosted vs downloaded).

This mechanism also allows us to publicly offer the documentation and downloads for licensed plugins. Without a license key, these plugins could serve in trial mode. For example, AdTonomy would only load a demo XML. That way, users can test and/or and implement the plugin before buying.

Versioning

Versioning for plugins is discarded. The latest version of a plugin is always hosted / downloaded. Developers themselves are responsible for the compatibility of their plugins with previous versions of the player.

It is clearly marked when plugins use features that are only available as of certain versions of the player.

Data gathering

For data gathering purposes, the following sources are available:

  • Accesslogs for hosted plugins (the majority of users will remain to use hosted plugins and the CMS will also use hosted plugins).
  • Accesslogs on the player watermark (the watermark on V5 will be hosted @ LTV, not precompiled into the player)
  • Accesslogs on the phone-home checks for licensed plugins.
  • Accesslogs on the player landing page (the rightclick).
  • Order reports on both the player licenses and plugin licenses.

Management

The new addons site will feature a management section where developers can login and update their plugins (addons).

One of the fields developers can manage is the 'hosted plugin' file field, where developers can upload new versions of their plugins. These plugins are instantly pushed live. Additionally, just about every item in the plugin detail page (description, compatibility, link, download, flashvars, example) can be set by the developer. In order to automate testing / example pages, we use a simple XML format to describe the flashvars of every plugin.

The first time a plugin is added to the addons section, it must be checked by an LT employee. If the plugin checks out, it is pushed live. Subsequent updates of the plugin by the developer do not require such a check anymore.