js2/mwEmbed/README

   1 ***********************************************
   2 *
   3 * mwEmbed version 1.2
   4 * for details see: http://www.mediawiki.org/wiki/MwEmbed
   5 * For an overview of all mwEmbed files see:
   6 * http://www.mediawiki.org/wiki/MwEmbed
   7 *
   8 * All Metavid Wiki code is Released under the GPL2
   9 *
  10 * @author Michael Dale,
  11 * @email mdale@wikimedia.org
  12 *
  13 *********************************************
  14
  15 v.1.1
  16 Major refactoring lots of new interfaces (full release info to follow shortly)
  17
  18 v.6
  19 * added msg system for compatibility with translations
  20 * add support for relative file or path names for media files for cortado.
  21 * added support for safari
  22 ** will force load javascript instead of DOM injection
  23 ** slower on pages without video clips
  24 * added "experimental" support for "sequences" and editing. (see http://metavid.ucsc.edu/blog/
  25 * improved playlists usage
  26
  27 v.5
  28 * add support for playlists, basic usage: <playlist id="plid" src="playlist.xml"/>
  29         * see sample_page.php for example usage of playlist
  30 * better support for different resolutions.
  31 * inline playlist:
  32
  33
  34
  35
  36 v.4
  37 * adds support for oggplay with playhead: http://www.annodex.net/software/plugin/index.html
  38 * adds linkback support (for adding a link back to a particular page)
  39 * adds config value for selecting cortado in an iframe or loaded in the page
  40
  41 v.3 an intermediary release: supports vlc, basic cortado, basic mplayer/totem
  42 well tested browsers are firefox & IE 6 (more testing needed for more browsers)
  43
  44
  45 the goal of mv_embed is to create a complete/wrapper fall back system for
  46 the liboggplay API:
  47
  48 http://wiki.xiph.org/index.php/OggPlayJavascriptAPI
  49
  50 & integrate the video element as close as possible with the html5 spec:
  51 http://www.whatwg.org/specs/web-apps/current-work/#video
  52
  53 it attempts to wrap these calls for the following players:
  54 I try to include a link to their Javascript apis if I can find one:
  55
  56 (initially just cortado and vlc)
  57 cortado applet: a custom build of the fluendos java based applet
  58 (included with the mv_embed package in the future we should get a signed applet hosted
  59 so that cross domain video playing does not require a copy of cortado+iframe on that server)
  60     http://www.flumotion.net/cortado/
  61
  62 vlc plugin: video lan client plugin
  63     http://www.videolan.org/doc/play-howto/en/ch04.html#id293992
  64
  65 mplayer plugin: the mplayer plugin
  66     http://mplayerplug-in.cvs.sourceforge.net/mplayerplug-in/mplayerplug-in/DOCS/tech/javascript.txt?view=markup
  67
  68 totem:
  69     http://www.gnome.org/projects/totem/
  70
  71
  72 Sample Usage:
  73 <script type="text/javascript" src="mv_embed.js" />
  74 <video id="video_id" src="video_url"></video>
  75
  76 once the page loads the video_id object is rewritten as an mv_embed object
  77
  78
  79 Supported Attributes for <video> tag:
  80 type    name            [default]       description
  81 bool    autoplay    [false]     if the clip should play on page load
  82 bool    controls        [true]          if the default interface should be displayed (see interface)
  83 string  id          null        the id of the html element useful for grabbing the video object
  84 string  src                     null            the url src for the video file
  85 string  thumbnail   logo        the thumbnail to be displayed a frame grab is ideal.
  86 string  linkback    link        a info link back for more info about this stream
  87                                                                 (useful for when the clip is embed externally)
  88 int     width       [320]       the video display width
  89 int     height      [240]       the video display height
  90 bool    embed_link  [ture]              if the html to embed this clip on an external page should be displayed