Changeset 2315


Ignore:
Timestamp:
07/11/12 06:49:44 (11 months ago)
Author:
jeroen
Message:

updated docs to talk about download and remove HLS support

Location:
branches/jw6/doc
Files:
18 edited

Legend:

Unmodified
Added
Removed

  • branches/jw6/doc/about.html

    r2269 r2315  
    4343    <td>AAC, MP3</td> 
    4444    <td>Yes</td> 
    45     <td>HLS, RTMP</td> 
     45    <td>RTMP</td> 
    4646</tr><tr> 
    4747    <td>Chrome</td> 
    … …  
    4949    <td>AAC, MP3, Vorbis</td> 
    5050    <td>Yes</td> 
    51     <td>HLS, RTMP</td> 
     51    <td>RTMP</td> 
    5252</tr><tr> 
    5353    <td>Firefox</td> 
    … …  
    5555    <td>AAC, MP3</td> 
    5656    <td>Yes</td> 
    57     <td>HLS, RTMP</td> 
     57    <td>RTMP</td> 
    5858</tr><tr> 
    5959    <td>Safari</td> 
    … …  
    9494<li>An automated and elegant model for <a href="modes.html">selecting HTML5 or Flash</a> for rendering the media.</li> 
    9595<li>An extensive list of options for easily <a href="embedding.html">configuring layout and behavior</a> of the player.</li> 
    96 <li>Comprehensive <a href="playlists.html">playlist support</a> for loading multiple media items, file formats and quality levels.</li> 
    97 <li>Display of <a href="captions.html">captions or subtitles</a> using MP4 text tracks or external SRT/DFXP files.</li> 
    9896</ul> 
    9997 
    … …  
    105103 
    106104<ul> 
    107 <li>Live and adaptive streaming through the <a href="">Apple HLS</a> and <a href="rtmp.html">Adobe RTMP</a> protocols.</li> 
    108 <li>Analytics callbacks to <a href="">Google Analytics</a> or any custom analytics backend.</li> 
    109 <li>Content discovery through the display of <a href="">Related Videos</a> or <a href="">Social Sharing</a> options.</li> 
    110 <li>In-stream advertising using the <a href="">Vast/VPaid standards</a> or <a href="">Self Hosted Ads</a>.</li> 
     105<li>Adaptive streaming through the <a href="rtmp.html">Adobe RTMP</a> protocol, plus support for <a href="pseudo.html">pseudo-streaming</a> in Flash.</li> 
     106<li>Comprehensive <a href="playlists.html">playlist support</a> for loading multiple media items, file formats and quality levels.</li> 
     107<li>Display of <a href="captions.html">captions or subtitles</a> using embedded MP4 text tracks or external WebVTT text files.</li> 
    111108</ul> 
    112109 
    113 <p>Extensive integrations with the popular <a href="">Drupal CMS</a> and <a href="">WordPress CMS</a> are available. They enable easy setup of JW Player and embedding of audio/video content into your site.</p> 
     110<p>Extensive integrations with the popular <a href="http://drupal.org/project/jwplayermodule">Drupal CMS</a> and <a href="http://wordpress.org/extend/plugins/jw-player-plugin-for-wordpress/">WordPress CMS</a> are available. They enable easy setup of JW Player and embedding of audio/video content into your site.</p> 
    114111 
    115112 

  • branches/jw6/doc/accessible.html

    r2223 r2315  
    110110</ul> 
    111111 
    112 <p>Note the example does not contain an audio description. JW Player 6 does not yet support audio descriptions (see below). This should not be a problem, since audio descriptions are not needed in the far majority of cases.</p> 
     112<p>Note the example does not contain an audio description. JW Player 6 does not yet support audio descriptions (see below).</p> 
    113113 
    114114 
    … …  
    122122<li>When Flash is used for rendering, it is not possible to <em>tab in</em> or <em>tab out</em> of the player using your keyboard. This is a major issue, since it essentially breaks keyboard access. Luckily, screen readers like JAWS do provide the option to enter/exit Flash elements. In HTML5, this problem does not exist.</li> 
    123123<li>On mobile devices, captions cannot yet be rendered by JW Player. This because there's no way to display anything on top of (full-screen) video on these devices. There is a workaround for iOS, using embedded <a href="captions.html">TX3G text tracks</a>.</li> 
    124 <li>For HTML5 in general, getting audio descriptions to work properly has proven very hard. On mobile devices, this is not possible at all, while on desktops sync issues are present.</li> 
     124<li>Audio descriptions are not yet supported on browsers and devices, but coming as part of the new HTML5 &lt;track&gt; element. For now, it is best to create two versions of your videos: one with and one without descriptions in the audio. Users can then select which one to play.</li> 
    125125</ul> 
     126 
     127<h3>About &lt;track&gt;</h3> 
    126128 
    127129<p><a href="http://blog.gingertech.net/2010/08/07/websrt-and-html5-media-accessibility/">Work is in progress</a> to build both captions and audio descriptions into HTML5. This is done through a new element: &lt;track&gt;. Though not built into any real-world browser yet, the <a href="http://www.w3.org/TR/html5/video.html">spec is mostly done</a>. This is how it will look:</p> 
    … …  
    134136</pre> 
    135137 
    136 <p>Browsers and devices will see the tracks, pick up the VTT files and render controls to toggle them on/off. VTT files are basically fancy SRT files, so if you provide your captions in SRT today, you can easily switch to VTT in the future.</p> 
     138<p>Browsers and devices will see the tracks, pick up the VTT files and render controls to toggle them on/off. VTT files are basically extended SRT files, so if you provide your captions in SRT today, you can easily switch to VTT in the future.</p> 
    137139 
    138 <p>Important to note is that the audio description is also a VTT text file. The browser (or screen reader) is supposed to load this file and provide text-to-speech synthesis. If this actually gets supported, the creation of audio descriptions will suddenly become much easier. Adding in the easy keyboard access, it's clear that HTML5 holds much promise for a broader implementation of accessible video.</p> 
     140<p>Important to note is that the audio description is also a VTT text file. The browser (or screen reader) is supposed to load this file and provide text-to-speech synthesis. If this actually gets supported, the creation of audio descriptions will become easy and affordable.</p> 
    139141 
    140142 

  • branches/jw6/doc/browsers.html

    r2223 r2315  
    3131<h2>Desktop Browsers</h2> 
    3232 
    33 <p>This table lists which desktop browsers are officially supported by JW Player, using HTML5 and/or Flash:</p> 
     33<p>This table lists which desktop browsers are fully supported by JW Player, using HTML5 and/or Flash:</p> 
    3434 
    3535<table><tr> 
    3636    <th>Browser</th><th>HTML5</th><th>Flash</th> 
    3737</tr><tr> 
    38     <td>Chrome 18 <sup>1</sup></td><td>yes</td><td>yes</td> 
     38    <td>Chrome <sup>1</sup></td><td>yes</td><td>yes</td> 
    3939</tr><tr> 
    40     <td>Firefox 3.6</td><td>-</td><td>yes</td> 
    41 </tr><tr> 
    42     <td>Firefox 12 <sup>1</sup></td><td>yes</td><td>yes</td> 
     40    <td>Firefox <sup>1</sup></td><td>yes</td><td>yes</td> 
    4341</tr><tr> 
    4442    <td>Internet Explorer 8</td><td>-</td><td>yes</td> 
    … …  
    4644    <td>Internet Explorer 9</td><td>yes</td><td>yes</td> 
    4745</tr><tr> 
    48     <td>Safari 5.1 <sup>1</sup></td><td>yes</td><td>yes</td> 
     46    <td>Safari <sup>1</sup></td><td>yes</td><td>yes</td> 
    4947</tr></table> 
    5048 
    … …  
    5351</ol> 
    5452 
    55 <p>All JW Player features are supported on all browsers, with the exception of media playback. In an nutshell, not all browsers play WebM video and Vorbis audio. See <a href="media.html">Supported Media Formats</a> for more details.</p> 
     53<p>All JW Player features are supported on these browsers, with the exception of media playback. In a nutshell, not all browsers support WebM video and Vorbis audio. See <a href="media.html">Supported Media Formats</a> for details.</p> 
    5654 
    57 <p>Another limitation is HTML5 Fullscreen support. Both Internet Explorer 9 and Opera 11.6 do not (yet) support true fullscreen in HTML5. Instead, the <em>FullScreen</em> button in JW Player will enable full-browser-screen playback of the video.</p> 
     55<p>One additional limitation is HTML5 Fullscreen support. Internet Explorer 9 does not (yet) support true fullscreen in HTML5. Instead, the <em>FullScreen</em> button in JW Player will enable full-browser-screen playback of the video.</p> 
    5856 
    5957 
    … …  
    8078 
    8179<ul> 
    82 <li>JW Player does not officially support Flash on mobile. Although Android devices may have Flash installed, the <a href="http://www.longtailvideo.com/blog/25057/html5-takes-the-lead-on-android-devices">user experience is suboptimal</a>. Therefore, we focus completely on HTML5.</il> 
    83 <li>JW Player uses the video controlbar provided by the device. That way, the buttons work well using Touch (the default skin is optimized for Mouse). Device-specific enhancements will also remain available (e.g. <em>Airplay</em> and <em>pinch-to-fullscreen</em> on iPad).</li> 
     80<li>JW Player does not officially support Flash on mobile. Although Android devices may have Flash installed, the <a href="http://www.longtailvideo.com/blog/25057/html5-takes-the-lead-on-android-devices">user experience is suboptimal</a>. Therefore, we focus 100% on HTML5.</il> 
     81<li>JW Player uses the video controls provided by the device. That way, the buttons work well using Touch (the default skin is optimized for Mouse). Device-specific enhancements will also remain available (e.g. <em>Airplay</em> and <em>pinch-to-fullscreen</em> on iPad).</li> 
    8482<li>On all phones (except in Android 4.0), video can only be played in <em>fullscreen</em> mode. On tablets, video can be played either windowed or in fullscreen.</li> 
    8583<li>Changing the <em>mute</em> state and <em>volume</em> is not possible. All mobile devices ignore these API calls, favoring the hardware buttons on the side of each device.</li> 
    … …  
    9795<ul> 
    9896<li>The <strong>HTML5</strong> &lt;video&gt; element. Available on most browsers and most devices.</li> 
    99 <li>The Adobe <strong>Flash</strong> plugin. Available on practically all browsers, but only few devices.</li> 
     97<li>The Adobe <strong>Flash</strong> plugin. Available on practically all browsers, but not on devices.</li> 
    10098</ul> 
    10199 
    … …  
    103101 
    104102<ul> 
    105 <li>MP4, AAC, MP3 and HLS can be played in both HTML5 and Flash.</li> 
    106 <li>WebM and Vorbis can only be played in HTML5.</li> 
     103<li>MP4, AAC and MP3 can be played in both HTML5 and Flash.</li> 
     104<li>WebM, Vorbis and HLS can only be played in HTML5.</li> 
    107105<li>FLV, RTMP and YouTube can only be played in Flash.</li> 
    108106</ul> 
    109107 
    110108 
    111 <p>At large, the market moves away from Flash in the direction of HTML5. Therefore, JW Player prefers to use HTML5 over Flash if a piece of content can be played in both modes on a certain browser. This behavior can be changed though, by setting the configuration option <strong>primary</strong> to <em>flash</em>. See <a href="embedding.html">Embedding the Player</a> for more info.</p> 
     109<p>At large, the market moves away from Flash towards HTML5. Therefore, JW Player prefers to use HTML5 over Flash if a piece of content can be played in both modes on a certain browser. This behavior can be changed though, by setting the configuration option <strong>primary</strong> to <em>flash</em>. See <a href="embedding.html">Embedding the Player</a> for more info.</p> 
    112110 
    113111<h3>Multiple Sources</h3> 
    … …  
    129127<h2><a name="fallback"></a>Download Fallback</h2> 
    130128 
    131 <p>In certain cases, neither the Flash nor HTML5 mode can be used. For example, a visitor might use a BlackBerry phone, or attempt to watch a WebM-only video in Safari. In those cases, JW Player can render a so-called <strong>fallback</strong>. Which fallback is rendered is defined by the embedded media format:</p> 
     129<p>In certain cases, neither Flash nor HTML5 mode can be used. For example, a visitor might use a BlackBerry phone, or attempt to watch a WebM-only video in Safari. In those cases, JW Player can render a so-called <strong>fallback</strong>. Which fallback is rendered is defined by the embedded media format:</p> 
    132130 
    133131<ul> 
    134 <li>For MP4, AAC or MP3 files, a nicely formatted download link is rendered. the link consists of the poster image with a <em>play</em> button on top of it. When a visitor clicks the link, the device's built-in mediaplayer will play the file.</li> 
    135 <li>For YouTube streams, the plain YouTube <em>&lt;embed&gt;</em> code is inserted. This triggers a special-case embed of the YouTube player on iOS and Android devices. Videos will simply play inline, but the JW Player interface is not available.</li> 
     132<li>For MP4, AAC or MP3 files, a nicely formatted download link is rendered. The link consists of the poster image with a <em>play</em> button on top of it. When a visitor clicks the link, the device's built-in mediaplayer will play the file.</li> 
     133<li>For YouTube streams, the plain YouTube <em>&lt;embed&gt;</em> code is inserted. This triggers a special-case embed of the YouTube player on iOS and Android devices. Videos will simply play inline, but the JW Player interface and API are not available.</li> 
    136134<li>For FLV, WebM and Vorbis files and RTMP or HLS streams, an <em>Unsupported Media Format</em> error message is displayed. This because these formats are likely not supported by built-in mediaplayers.</li> 
    137135<li>When using an <a href="playlists.html#rss">RSS Feed</a> instead of an inline playlist, the <em>Unsupported Media Format</em> message is also displayed. JW Player does not load and parse RSS feeds as part of the download fallback.</li> 

  • branches/jw6/doc/captions.html

    r2314 r2315  
    22<html> 
    33<head> 
    4 <title>Adding Closed Captions</title> 
     4<title>Adding Video Captions</title> 
    55<style> 
    66    body { padding: 50px 100px; width: 700px; font: 13px/20px Arial; background: #FFF; } 
    … …  
    2121</head><body> 
    2222 
    23 <h1>Adding Closed Captions</h1> 
    24  
    25 <p>JW Player supports the display of closed captions or subtitles in the video display. Captions can be shown or hidden with a toggle or, when presenting multiple languages, a popup menu. This guide explains how to add captions to your player embeds.</p> 
     23<h1>Adding Video Captions</h1> 
     24 
     25<p>JW Player supports the rendering of closed captions or subtitles in the video display. Captions can be shown or hidden with a toggle or, when presenting multiple languages, a popup menu. This guide explains how to add captions to your player embeds.</p> 
    2626 
    2727 
    … …  
    3636</ul> 
    3737 
    38 <p>Note that WebVTT builds upon the SRT (<a href="http://en.wikipedia.org/wiki/SubRip">SubRip</a>) format, which is also supported. However, neither format is supported on all desktop browsers and mobile devices. Here is the breakdown:</p> 
     38<p>Note that WebVTT builds upon the SRT (<a href="http://en.wikipedia.org/wiki/SubRip">SubRip</a>) format, which is also supported by JW Player.</p> 
     39 
     40<p>Unfortunately, neither external nor embedded captions are supported on all desktop browsers and mobile devices. Here is the breakdown:</p> 
    3941 
    4042<table><tr> 
    … …  
    4850<p>WebVTT does not work on mobile devices, since it is not possible for JW Player to <em>polyfill</em> the captions on top of the video during (full-screen) playback. Support for <a href="http://www.longtailvideo.com/html5/#accessibility">HTML5 Text Tracks</a> on iOS and Android will fix this in the (hopefully near-term) future.</p> 
    4951 
    50 <p>TX3G tracks do render on iOS (still not on Android), but on desktops they only display in Flash. TX3G tracks are also hard to edit, since they require tools (like <a href="http://handbrake.fr">Handbrake</a>) to <em>mux</em> your MP4 files. SRT and DFXP files can be authored with any text editor.</p> 
     52<p>TX3G tracks do render on iOS (still not on Android), but on desktops they only display in Flash. TX3G tracks are also hard to edit, since they require tools (like <a href="http://handbrake.fr">Handbrake</a>) to <em>mux</em> your MP4 files. WebVTT files can be authored with any text editor.</p> 
    5153 
    5254 
    … …  
    5961WEBVTT 
    6062 
    61 1 
    626300:00:08.000 --&gt; 00:00:10.000 
    6364Nothing is going on. 
    6465 
    65 2 
    666600:00:10.500 --&gt; 00:00:12.500 
    6767Violet, please! 
    6868- I am not your babe! 
    6969 
    70 3 
    717000:00:17.000 --&gt; 00:00:20.000 
    7271You stupid cow, 
    … …  
    189188WEBVTT 
    190189 
    191 1 
    19219000:00:08.000 --&gt; 00:00:10.000 
    193191&lt;b>Nothing&lt;/b> is going on. 
    194192 
    195 2 
    19619300:00:10.500 --&gt; 00:00:12.500 
    197194&lt;font color="#3333CC"&gt;Violet, &lt;i&gt;please&lt;/i&gt;!&lt;/font&gt; 
    … …  
    227224    <td>German</td><td>de</td><td>deu, ger</td> 
    228225</tr><tr> 
    229     <td>Greek</td><td>el</td><td>gre, ell</td> 
    230 </tr><tr> 
    231226    <td>Hindi</td><td>hi</td><td>hin</td> 
    232227</tr><tr> 
    … …  
    255250    <td>Swedish</td><td>sv</td><td>swe</td> 
    256251</tr><tr> 
    257     <td>Thai</td><td>th</td><td>tha</td> 
    258 </tr><tr> 
    259252    <td>Turkish</td><td>tr</td><td>tur</td> 
    260 </tr><tr> 
    261     <td>Vietnamese</td><td>vi</td><td>vie</td> 
    262253</tr></table> 
    263254 

  • branches/jw6/doc/crossdomain.html

    r2269 r2315  
    3131<ul> 
    3232<li><a href="feeds.html">RSS feeds</a></li> 
    33 <li><a href="skins.html">ZIP/XML skins</a></li> 
    34 <li><a href="captions.html">SRT/DFXP captions</a></li> 
     33<li><a href="skins.html">ZIP skins</a></li> 
     34<li><a href="captions.html">VTT captions</a></li> 
    3535<li><a href="rtmp.html">SMIL manifests</a></li> 
    36 <li><a href="hls.html">M3U8 manifests</a></li> 
    3736</ul> 
    3837 
    … …  
    8685<li><a href="feeds.html">RSS feeds</a></li> 
    8786<li><a href="skins.html">XML skins</a></li> 
    88 <li><a href="captions.html">SRT captions</a></li> 
     87<li><a href="captions.html">VTT captions</a></li> 
    8988</ul> 
    9089 

  • branches/jw6/doc/embedding.html

    r2310 r2315  
    2424<h2>Player Setup</h2> 
    2525 
    26 <p>Since JW Player is CDN hosted, there is no need to install and upload the player to your site. Therefore, embedding the JW Player is a simple, 3-step process. Open your web page in an HTML editor and:</p> 
     26<p>Before a player can be embedded, the 3 JW Player files (and your media files) need to be uploaded to your site. See the <a href="quickstart.html">Quick Start</a> for more info on this. With the files online, embedding the JW Player is a simple, 3-step process. Open your web page in an HTML editor and:</p> 
    2727 
    2828<ol> 
    29 <li>Insert the JW Player script from our CDN into the head of your page: 
    30 <pre>&lt;script type="text/javascript" src="http://jwpcdn.com/player.js" &gt;&lt;/script&gt;</pre> 
     29<li>Embed the main JW Player script library into the head of your page (note the Flash and HTML5 player area automatically loaded): 
     30<pre>&lt;script type="text/javascript" src="/scripts/jwplayer.js" &gt;&lt;/script&gt;</pre> 
    3131</li> 
    3232<li>Insert a &lt;div&gt; element with a unique <em>id</em> at the location you want the player to appear: 
    … …  
    6161</dl> 
    6262 
    63 <p>Overall, the <strong>file</strong> option can be used only for basic setups, like playing a single MP4 video or MP3 song. Use the <strong>playlist</strong> option for everything else, like an MP4+WebM source, SD+HD quality or a list with multiple items. See <a href="playlists.html">Working with Playlists</a> for more info.</p> 
     63<p>Overall, the <strong>file</strong> option can be used only for basic setups, like playing a single MP4 video or AAC song. Use the <strong>playlist</strong> option for everything else, like an MP4+WebM source, SD+HD quality or a list with multiple items. See <a href="playlists.html">Working with Playlists</a> for more info.</p> 
    6464 
    6565 
    … …  
    7474<dd>Height of the player in pixels. We recommend setting this to at least <strong>180</strong>, so all UI elements will fit. However, it can be set to a small size (e.g. <strong>40</strong>) for audio-only playback. Defaults to <strong>360</strong>.</dd> 
    7575<dt>skin</dt> 
    76 <dd>Which skin to use for styling the player. Can be the identifier of a CDN hosted skin or the URL to a self-hosted skin. See <a href="skins.html">Using JW Player Skins</a> for more info.</dd> 
     76<dd>Which skin to use for styling the player. Is set to the URL of that skin on your site. See <a href="skins.html">Using JW Player Skins</a> for more info. Is not set by default, so the standard skin is used.</dd> 
    7777<dt>stretching</dt> 
    7878<dd>How to resize the poster and video to fit the display. Can be <strong>none</strong> (keep original dimensions), <strong>exactfit</strong> (stretch disproportionally), <strong>uniform</strong> (stretch proportionally;  black borders) or <strong>fill</strong> (stretch proportionally; parts cut off). Defaults to <strong>uniform</strong>.</dd> 
    7979<dt>width</dt> 
    80 <dd>Width of the player in pixels. We recommend setting this to at least <strong>320</strong>. On smaller players, certain UI elements may not fit.  Defaults to <strong>640</strong>.</dd> 
     80<dd>Width of the player in pixels. We recommend setting this to at least <strong>320</strong>. On smaller players, certain UI elements may not fit. Defaults to <strong>640</strong>.</dd> 
    8181</dl> 
    8282 
    … …  
    8888<dl> 
    8989<dt>autostart</dt> 
    90 <dd>Automatically start playing the video on page load. Can be <strong>true</strong> or <strong>false</strong> (default). Autostart does not work on mobile devices like iOS or Android.</dd> 
     90<dd>Automatically start playing the video on page load. Can be <strong>true</strong> or <strong>false</strong> (default). Autostart does not work on mobile devices like iOS and Android.</dd> 
    9191<dt>fallback</dt> 
    92 <dd>Whether to render a nice download link for the video if HTML5 and/or Flash are not supported. Can be <strong>true</strong> (a fallback is rendered; the default) or <strong>false</strong> (the original HTML is not touched).</dd> 
     92<dd>Whether to render a nice download link for the video if HTML5 and/or Flash are not supported. Can be <strong>true</strong> (a fallback is rendered) or <strong>false</strong> (the original HTML is not touched). Defaults to <strong>true</strong>.</dd> 
    9393<dt>mute</dt> 
    9494<dd>Whether to have the sound muted on startup or not. Can be <strong>false</strong> (default) or <strong>true</strong>.</dd> 
    … …  
    9696<dd>Which rendering mode to try first for rendering the player. Can be <strong>html5</strong> (default) or <strong>flash</strong>.</dd> 
    9797<dt>repeat</dt> 
    98 <dd>What to do when an item finished playback. Can be <strong>list</strong> (play the full playlist once), <strong>none</strong> (stop playback after every item), <strong>always</strong> (repeat the playlist forever) or <strong>single</strong> (repeat the active item forever).  Defaults to <strong>list</strong>.</dd> 
     98<dd>What to do when an item finished playback. Can be <strong>list</strong> (play the next item until playlist is done), <strong>none</strong> (stop playback after every item), <strong>always</strong> (repeat the playlist forever) or <strong>single</strong> (repeat the current item forever).  Defaults to <strong>list</strong>.</dd> 
    9999<dt>startparam</dt> 
    100 <dd>Querystring parameter for seeking to not-yet-download portions of FLV or MP4 files in Flash mode. Not needed for HTML5 (works by default). See <a href="pseudo.html">Pseudostreaming in Flash</a> for more info.</dd> 
     100<dd>Querystring parameter for seeking to not-yet-download portions of FLV or MP4 files in Flash mode. Not needed for HTML5 (where this works by default). See <a href="pseudo.html">Pseudostreaming in Flash</a> for more info.</dd> 
    101101</dl> 
    102102 
    … …  
    126126<dl> 
    127127<dt>sidebar</dt> 
    128 <dd>Config block for displaying a sidebar with the <a href="playlists.html#sidebar">Playlist contents</a>.</dd> 
     128<dd>Config block for displaying a sidebar with the <a href="playlists.html#sidebar">playlist contents</a>.</dd> 
    129129<dt>captions</dt> 
    130130<dd>Config block for tweaking the display of <a href="captions.html">captions or subtitles</a>.</dd> 
     131<dt>rtmp</dt> 
     132<dd>Config block for tweaking the playback of <a href="rtmp.html">RTMP streams</a>.</dd> 
    131133<dt>logo</dt> 
    132134<dd>Config block for displaying an <a href="logo.html">on-screen watermark</a>.</dd> 
    133 <dt>rtmp</dt> 
    134 <dd>Config block for tweaking the playback of <a href="rtmp.html">RTMP streams</a>.</dd> 
    135 <!-- 
    136 <dt>gapro</dt> 
    137 <dd>Config block for pinging events to <a href="#">Google Analytics</a>.</dd> 
    138 <dt>related</dt> 
    139 <dd>Config block for displaying an overlay with <a href="#">Related Videos</a>.</dd> 
    140 <dt>sharing</dt> 
    141 <dd>Config block for displaying an overlay with <a href="#">Social Sharing links</a>.</dd> 
    142 <dt>ova</dt> 
    143 <dd>Config block for loading ads using the <a href="#">VAST/VPaid standards</a>.</dd> 
    144 <dt>adtonomy</dt> 
    145 <dd>Config block for loading ads using <a href="#">self-hosted assets</a>.</dd> 
    146 --> 
    147135</dl> 
    148136 

  • branches/jw6/doc/feeds.html

    r2223 r2315  
    9797    <td>description</td><td>description</td><td></td> 
    9898</tr><tr> 
    99     <td>mediaid</td><td>guid</td><td>Possibly using <em>isPermalink="false"</em></td> 
     99    <td>mediaid</td><td>guid</td><td>Set <em>isPermalink="false"</em> attribute</td> 
    100100</tr><tr> 
    101101    <td>image</td><td>media:thumbnail@url</td><td></td> 
    … …  
    105105    <td>source.file</td><td>media:content@url</td><td></td> 
    106106</tr><tr> 
    107     <td>source.type</td><td>media:content@type</td><td>Should be a mimetype (<em>video/mp4</em>)</td> 
     107    <td>source.type</td><td>media:content@type</td><td>Must be a mimetype (<em>video/mp4</em>)</td> 
    108108</tr><tr> 
    109109    <td>source.width</td><td>media:content@width</td><td></td> 

  • branches/jw6/doc/index.html

    r2314 r2315  
    3838<li><a href="embedding.html">Embedding the Player</a></li> 
    3939<li><a href="troubleshooting">Troubleshooting your Setup</a></li> 
    40 <li><a href="pseudo.html">Pseudo-streaming in Flash</a></li> 
    4140</ul> 
    4241 
    … …  
    4847</ul> 
    4948 
    50 <h3>Captioning</h3> 
     49<h3>Captions</h3> 
    5150<ul> 
    52 <li><a href="captions.html">Adding Closed Captions</a></li> 
     51<li><a href="captions.html">Adding Video Captions</a></li> 
    5352<li><a href="accessible.html">Making Videos Accessible</a></li> 
    5453</ul> 
    … …  
    6766</ul> 
    6867 
    69 <h3>Branding</h3> 
    70 <ul> 
    71 <li><a href="logo.html">Displaying a Logo</a></li> 
    72 </ul> 
    73  
    7468<h3>Streaming</h3> 
    7569<ul> 
    7670<li><a href="rtmp.html">Using RTMP Streaming</a></li> 
    77 <li>Using HTTP Dynamic Streaming</li> 
    78 <li>Using HTTP Live Streaming</li> 
     71<li><a href="pseudo.html">Pseudo-streaming in Flash</a></li> 
    7972</ul> 
    8073 
    81 <h3>Discovery</h3> 
     74<h3>Branding</h3> 
    8275<ul> 
    83 <li>Enabling Social Sharing</li> 
    84 <li>Showing Related Videos</li> 
    85 </ul> 
    86  
    87 <h3>Analytics</h3> 
    88 <ul> 
    89 <li>Connecting to Google Analytics</li> 
    90 </ul> 
    91  
    92 <h3>Advertising</h3> 
    93 <ul> 
    94 <li>Running VAST/VPaid Ads</li> 
    95 <li>Running Self Hosted Ads</li> 
     76<li><a href="logo.html">Displaying Your Logo</a></li> 
    9677</ul> 
    9778 

  • branches/jw6/doc/logo.html

    r2223 r2315  
    22<html> 
    33<head> 
    4 <title>Displaying a Logo</title> 
     4<title>Displaying Your Logo</title> 
    55<style> 
    66    body { padding: 50px 100px; width: 700px; font: 13px/20px Arial; background: #FFF; } 
    … …  
    2121</head><body> 
    2222 
    23 <h1>Displaying a Logo</h1> 
     23<h1>Displaying Your Logo</h1> 
    2424 
    2525<p>The Free version of JW Player contains a small logo in the top right corner of the display. In the Pro version, this logo is gone. Instead, publishers are able to set their own logo, e.g. to add some branding or to implement a Call-to-Action. This guide explains how to do so.</p> 

  • branches/jw6/doc/media.html

    r2223 r2315  
    8282<li><a href="http://en.wikipedia.org/wiki/Advanced_Audio_Coding">AAC</a> audio files. AAC is of high quality and supported by all browsers and devices.</li> 
    8383<li><a href="http://en.wikipedia.org/wiki/MP3">MP3</a> audio files. Though not as good in quality as AAC, MP3 is very widely used. Many existing audio libraries are encoded in MP3.</li> 
    84 <li>Ogg <a href="http://en.wikipedia.org/wiki/Vorbis">Vorbis</a> audio files. Vorbis is royalty-free, but has limited browser and device support.</li> 
     84<li><a href="http://en.wikipedia.org/wiki/Vorbis">Vorbis</a> audio files. Vorbis is royalty-free, but has limited browser and device support.</li> 
    8585</ul> 
    8686 
    … …  
    141141 
    142142<ul> 
    143 <li>Apple's <a href="http://en.wikipedia.org/wiki/HTTP_Live_Streaming">HLS</a> protocol, using M3U8 manifest files and TS media files. HLS builds upon standard HTTP, making it easy to deploy and firewall resilient. It is still under development, plus CDN and encoder support is still limited. See <a href="#">Using HLS Streaming</a> for more info.</li> 
    144 <li>Adobe's <a href="http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol">RTMP</a> protocol, using SMIL manifest files and MP4, FLV, AAC or MP3 media files. RTMP requires dedicated server software and is sometimes blocked by firewalls. It is mature and has broad CDN and encoder support. See <a href="#">Using RTMP Streaming</a> for more info.</li> 
     143<li>Adobe's <a href="http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol">RTMP</a> protocol, using SMIL manifest files and MP4, FLV, AAC or MP3 media files. RTMP is mature and has broad CDN and encoder support. It requires dedicated server software though, and is sometimes blocked by firewalls. See <a href="rtmp.html">Using RTMP Streaming</a> for more info.</li> 
     144<li>Apple's <a href="http://en.wikipedia.org/wiki/HTTP_Live_Streaming">HLS</a> protocol, using M3U8 manifest files and TS media files. HLS builds upon standard HTTP, making it easy to deploy and firewall resilient. It is still under development, plus CDN and encoder support is still limited.</li> 
    145145</ul> 
    146146 
    … …  
    148148 
    149149<table><tr> 
    150     <th></th><th>hls</th><th>rtmp</th> 
     150    <th></th><th>rtmp</th><th>hls</th> 
    151151</tr><tr> 
    152     <th>Extension(s)</th><td>.m3u8</td><td>.smil</td> 
     152    <th>Extension(s)</th><td>.smil</td><td>.m3u8</td> 
    153153</tr><tr> 
    154     <th>Mimetype</th><td>application/vnd.apple.mpegurl</td><td>application/smil</td> 
     154    <th>Mimetype</th><td>application/smil</td><td>application/vnd.apple.mpegurl</td> 
    155155</tr><tr> 
    156     <th>Internet Explorer</th><td>flash <sup>1</sup></td><td>flash</td> 
     156    <th>Internet Explorer</th><td>flash</td><td>-</td> 
    157157</tr><tr> 
    158     <th>Chrome</th><td>flash <sup>1</sup></td><td>flash</td> 
     158    <th>Chrome</th><td>flash</td><td>-</td> 
    159159</tr><tr> 
    160     <th>Firefox</th><td>flash <sup>1</sup></td><td>flash</td> 
     160    <th>Firefox</th><td>flash</td><td>-</td> 
    161161</tr><tr> 
    162     <th>Safari</th><td>html5, flash <sup>1</sup></td><td>flash</td> 
     162    <th>Safari</th><td>flash</td><td>html5</td> 
    163163</tr><tr> 
    164     <th>iOS</th><td>html5</td><td>-</td> 
     164    <th>iOS</th><td>-</td><td>html5</td> 
    165165</tr><tr> 
    166     <th>Android</th><td>html5 <sup>2</sup></td><td>-</td> 
     166    <th>Android</th><td>-</td><td>html5 <sup>1</sup></td> 
    167167</tr></table> 
    168168 
    169169<ol> 
    170     <li>HLS playback requires Flash Player 10.1, which <a href="http://riastats.com/">is not yet ubiquitous</a>.</li> 
    171170    <li>HLS support as of Android 4.</li> 
    172171</ol> 

  • branches/jw6/doc/notes.html

    r2223 r2315  
    2929<h2><a name="60"></a>Version 6.0 | build 2xxx</h2> 
    3030 
    31 <p>Initial release of JW6. Contains no specific <em>bug fixes</em>, but a large number of enhancements. Additionally, several features present in JW5 were deprecated in this release.</p> 
     31<p>Initial release of JW6. Contains no specific <em>bug fixes</em>, but a large number of enhancements. Additionally, several features present in JW5 were removed to make the player smaller in size and easier to setup.</p> 
    3232 
    3333<h3>Player Enhancements</h3> 
    … …  
    4444<dt>Improved HTML5/Flash selection</dt> 
    4545<dd>Selection of HTML5 or Flash for rendering the player used to be based upon a single configuration option. In JW6, the player actually detects the supplied media formats and active browser capabilities to select HTML5 or Flash specifically for each visitor.</dd> 
    46 <dt>Apple HLS support</dt> 
    47 <dd>JW6 introduces support for playback of Apple HLS streams, in both Flash and HTML5 rendering mode. This allows publishers to use a single HTTP adaptive streaming format for playback across desktop browsers and mobile devices.</dd> 
     46<dt>New JavaScript API Calls</dt> 
     47<dd>JW6 introduces JavaScript API classes for controlling quality levels, controlling captions tracks and setting custom dock buttons. Distinct API calls are added for retrieving the rendering mode (Flash/HTML5), listening to playlist completion and listening to display clicks.</dd> 
     48<dt>New Skinning Options</dt> 
     49<dd>The skinning model of JW Player is extended to include a tooltip (for hovering dock buttons or the time slider), error messages and video titles in the display and many more small enhancements.</dd> 
    4850</dl> 
    4951 
    5052 
    51 <h3>Deprecated Functionalities</h3> 
     53<h3>Removed Functionalities</h3> 
    5254 
    5355<dl> 
    … …  
    5557<dd>JW6 focuses on audio/video playback. We suggest using one of the many free JavaScript image gallery scripts instead.</dd> 
    5658<dt>Embedding with <em>&lt;embed&gt;</em> or <em>SWFObject</em></dt> 
    57 <dd>JW6 focuses on HTML5 and mobile, leveraging its internal <strong>jwplayer.setup()</strong> method. The &lt;embed&gt; and SWFObject methods are Flash-only and therefore not supported anymore. For situations where short, simple codes are required (e.g. social sharing), we recommend using an <strong>&lt;iframe&gt;</strong> tag.</dd> 
     59<dd>JW6 focuses on HTML5 and mobile, leveraging its internal <strong>jwplayer.setup()</strong> method. The &lt;embed&gt; and SWFObject methods are Flash-only and therefore not supported anymore.</dd> 
    5860<dt>Embedding over a <em>&lt;video&gt;</em> tag</dt> 
    5961<dd>JW6 supports many functionalities not supported by a &lt;video&gt; tag (e.g. Flash rendering, RSS feeds, YouTube videos, RTMP streaming, VAST/VPaid advertising). Additionally, most of the promises of an inline &lt;video&gt; element (progressive enhancement, video SEO, accessibility) are not realized yet. Therefore, JW6 focuses on embedding using JavaScript and <strong>jwplayer.setup()</strong>.</dd> 
    … …  
    6365<dd>The PNG/XML skinning model of JW Player is more flexible, is less error-prone and works in HTML5. Therefore, SWF skinning has been removed altogether in favor of this.</dd> 
    6466<dt>Feeds in XSPF/ASX/ATOM format</dt> 
    65 <dd>Media playback has standardized around Media RSS the last few years. In order to improve clarity and reduce the filesize of the player library, support for other feed formats is removed. Media RSS support is extended to work in both Flash and HTML5.</dd> 
     67<dd>Media playback has standardized around Media RSS the last few years. In order to improve clarity and reduce the filesize of the player library, support for other feed formats is removed.</dd> 
    6668<dt>Loading of a <em>config</em> XML with player options</dt> 
    67 <dd>The removal of &lt;embed&gt; support also removed the need for external XML configurations. External configurations can now be loaded as part of the player itself using an <strong>&lt;iframe&gt;</strong> tag.</dd> 
     69<dd>The removal of &lt;embed&gt; support also removed the need for external XML configurations. External configurations can now be loaded as part of the player itself, e.g. using an <strong>&lt;iframe&gt;</strong> tag.</dd> 
    6870<dt>Video trimming with the <em>start</em> and <em>duration</em> options</dt> 
    6971<dd>This functionality was removed because it works inconsistently on desktop browsers and not at all on mobile devices. We strongly urge developers that used this functionality to either trim and re-encode their actual videos (using a tool like <strong>HandBrake</strong>) or install a tool (like <strong>mod_h264</strong> or <strong>Wowza</strong>) to trim videos server side.</dd> 
    7072<dt>The <em>link</em> and <em>displayclick</em> options</dt> 
    7173<dd>These options were removed to tighten up the display UX and reduce the number of possible XSS security issues. Publishers can still implement Call-To-Action features in JW6 using the <strong>logo</strong> options, or respond to display clicks using the <strong>onDisplayClick</strong> API call.</dd> 
    72 <dt>The RTMP tunneling fallback</dt> 
     74<dt>Captioning with DFXP files</dt> 
     75<dd>Since WebVTT is becoming the de facto file format for online captions, we added support for it in JW6. We removed DFXP support, leading to a considerable decrease in player filesize. A tool for converting DFXP to VTT are available on our developer site.</dd> 
     76<dt>RTMP tunneling fallback</dt> 
    7377<dd>Due to the diversity of RTMP setups (ports, firewalls, protocols), the automated RTMP tunneling feature in JW5 tended to create as many issues as it solved. Therefore, this functionality was removed from JW6. Instead, we ensured <strong>onError()</strong> is called when an RTMP server cannot be reached. Publishers can then fallback from RTMP in any way they wish using a few lines of JavaScript code.</dd> 
     78 
    7479</dl> 
    7580 

  • branches/jw6/doc/quickstart.html

    r2269 r2315  
    2323<h1>Quick Start</h1> 
    2424 
    25 <p>Getting JW Player up and running is now easier than ever. Only a few lines of HTML code is needed to embed a video that works on any desktop, tablet and phone. Since the player is now CDN hosted, you don't even have to upload the player to your server anymore.</p> 
     25<p>Getting JW Player up and running is now easier than ever. Only a few lines of HTML code is needed to embed a video that works on any desktop browser and mobile device. This guide walks through the necessary steps.</p> 
    2626 
    2727 
    2828 
    29 <h2>Uploading the Video</h2> 
     29<h2>Uploading the Files</h2> 
    3030 
    31 <p>In order to embed the player, you first need a video file uploaded to your server. Ensure it is in the MP4 format, since that can be played on any browser and device (including iPad, iPhone and Android).</p> 
     31<p>In order to embed a video, you first need the file uploaded to your server. Ensure it is in the MP4 format, since that can be played on any browser and device (including iPad, iPhone and Android).</p> 
    3232 
    3333<ul> 
    3434<li>If your video is not in the MP4 format, you can convert it using a free tool like Handbrake. See our <a href="">Video Encoding guide</a> for more info.</li> 
    3535<li>If you have no video at hand, feel free to use <a href="http://content.bitsontherun.com/videos/bkaovAYt-52qL9xLP.mp4">this short clip</a> for your testing.</li> 
    36 <li>If you have no web server for uploading videos, check out <a href="http://www.longtailvideo.com/bits-on-the-run/">our video platform</a>. It offers you a free GB of storage, plus it automatically converts your video to MP4.</li> 
    3736</ul> 
    3837 
    39 <p>Additionally, you should upload a poster image to your server. This image (in JPG format) is displayed before the video starts. An interesting frame from the video usually works well to draw attention and entices users to click <em>play</em>. <a href="http://content.bitsontherun.com/thumbs/bkaovAYt-480.jpg">Here is an image</a> for our short test clip.</p> 
     38<p>Second, you should grab JW Player <a href="http://www.longtailvideo.com/players/jw-flv-player/">from our site</a> and upload it to your webserver. The following three files need uploaded and placed in a directory that's accessible from the internet:</p> 
     39 
     40<ol> 
     41<li><strong>jwplayer.js</strong>: the overall embed library.</li> 
     42<li><strong>jwplayer.html5.js</strong>: the actual HTML5 player.</li> 
     43<li><strong>jwplayer.flash.js</strong>: the actual Flash player.</li> 
     44</ol> 
     45 
     46<p>Third, you should upload a poster image to your server. This image (in JPG format) is displayed before the video starts. An interesting frame from the video usually works well to draw attention and entices users to click <em>play</em>. <a href="http://content.bitsontherun.com/thumbs/bkaovAYt-480.jpg">Here is an image</a> for our short test clip.</p> 
    4047 
    4148 
    … …  
    4350<h2>Embedding the Player</h2> 
    4451 
    45 <p>Since JW Player is hosted on our content delivery network (CDN), there is no need to install and upload the player itself to your site. Therefore, embedding the JW Player is a simple, 3-step process. Open your web page in an HTML editor and:</p> 
     52<p>With all files uploaded to your site, embedding the JW Player is a simple, 3-step process. Open your web page in an HTML editor and:</p> 
    4653 
    4754<ol> 
    48 <li>Insert the JW Player script from our CDN into the head of your page: 
    49 <pre>&lt;script type="text/javascript" src="http://jwpcdn.com/player.js" &gt;&lt;/script&gt;</pre> 
     55<li>Load the JW Player embed library from the head of your page: 
     56<pre>&lt;script type="text/javascript" src="/scripts/jwplayer.js" &gt;&lt;/script&gt;</pre> 
    5057</li> 
    5158<li>Insert a &lt;div&gt; element with a unique <em>id</em> at the location you want the player to appear: 
    … …  
    6976<h2>Next Steps</h2> 
    7077 
    71 <p>That's it! With a few lines of code, you embedded a video that can be watched on any desktop browser, tablet or mobile phone. <a href="">Here's a working example</a>. We also have basic examples for <a href="">embedding an MP3 file</a> and <a href="">embedding a YouTube video</a>.</p> 
    72  
    73 <p>JW Player supports many options for enhancing and tuning your audio or video embeds. Here are a few interesting guides to look into next:</p> 
     78<p>That's it! With a few lines of code, you embedded a video that can be watched on any desktop browser, tablet or mobile phone. Next, JW Player supports many options for enhancing and tuning your audio or video embeds. Here are a few interesting guides:</p> 
    7479 
    7580<ul> 
    7681<li><a href="media.html">Supported Media Formats</a> lists audio and video types can be played on which browsers &amp; devices.</li> 
    7782<li><a href="embedding.html">Embedding JW Player</a> lists all options for modifying the player's layout and behavior.</li> 
    78 <li><a href="skins.html">Using JW Player Skins</a> explains how to completely change the player's design through skinning.</li> 
    79 <li><a href="">Using the JavaScript API</a> explains how to build rich player interactions with JavaScript.</li> 
    8083</ul> 
     84<ul> 
     85<li><a href="playlists.html">Working with Playlists</a> explains how to group multiple videos into a playlist.</li> 
     86<li><a href="captions.html">Adding Video Captions</a> explains how to add closed captions or subtitles to your embeds.</li> 
     87</ul> 
     88<ul> 
     89<li><a href="skins.html">Using JW Player Skins</a> explains how to customize the player's design through skinning.</li> 
     90<li><a href="scripting.html">Using the JavaScript API</a> explains how to build rich player interactions with JavaScript.</li> 
     91</ul> 
     92<ul> 
     93<li><a href="rtmp.html">Using RTMP Streaming</a> explains how to setup live and/or adaptive streaming.</li> 
     94</ul> 
     95 
    8196 
    8297 

  • branches/jw6/doc/rtmp.html

    r2223 r2315  
    4747</ul> 
    4848 
    49 <p>The biggest drawback is that RTMP only works in Flash and not in HTML5. Therefore, the protocol is basically on its way out today. Newer streaming protocols based upon HTTP (like <a href="hls.html">Apple HLS</a>) have wider device support (iOS, Android). They are currently replacing RTMP.</p> 
     49<p>The biggest drawback is that RTMP only works in Flash and not in HTML5. Therefore, the protocol is basically on its way out today. New HTTP streaming protocols, like Apple's HTTP Live Streaming, have wider device support (iOS, Android) and will replace RTMP in the future.</p> 
    5050 
    5151 

  • branches/jw6/doc/script-reference.html

    r2308 r2315  
    2727 
    2828 
    29 <h2>Ready</h2> 
     29<h2><a name="ready"></a>Ready</h2> 
    3030 
    3131<p>These API calls are used to learn when and with which technology players are instantiated.</p> 
    … …  
    4141 
    4242 
    43 <h2>Playlist</h2> 
     43<h2><a name="playlist"></a>Playlist</h2> 
    4444 
    4545<p>These API calls are used for loading and retrieving the current playlist (of one or more items), as well as for navigating between playlist items.</p> 
    … …  
    8080 
    8181 
    82 <h2>Buffering</h2> 
     82<h2><a name="buffering"></a>Buffering</h2> 
    8383 
    8484<p>These API calls are used to update clients with the percentage of a file that's buffered into the player. This only applies to progressive downloads of media; streaming media do not expose this behavior.</p> 
    … …  
    9595 
    9696 
    97 <h2>Playback</h2> 
     97<h2><a name="playback"></a>Playback</h2> 
    9898 
    9999<p>These API calls are used to retrieve and change the current playback state of the player: is the player idle, buffering, playing or paused.</p> 
    … …  
    132132 
    133133 
    134 <h2>Seeking</h2> 
     134<h2><a name="seeking"></a>Seeking</h2> 
    135135 
    136136<p>These API calls are used to retrieve and update the current media playback position.</p> 
    … …  
    159159 
    160160 
    161 <h2>Volume</h2> 
     161<h2><a name="volume"></a>Volume</h2> 
    162162 
    163163<p>These API calls are used to change the playback volume of the player.</p> 
    … …  
    185185 
    186186 
    187 <h2>Resizing</h2> 
     187<h2><a name="resizing"></a>Resizing</h2> 
    188188 
    189189<p>These API calls are used to retrieve and update the current player dimensions and fullscreen state. Note there is no API call to <strong>set</strong> the fullscreen state, due to phishing-related security restrictions in both Flash and HTML5.</p> 
    … …  
    212212 
    213213 
    214 <h2>Error</h2> 
    215  
    216 <p>This API call allows developers to listen for and react to media playback errors (e.g. when a video URL is not found or a streaming server disconnects).</p> 
    217  
    218 <dl><dt>onError(<em>callback</em>)</dt><dd> 
    219 Fired when a media playback error has occurred in the player. An error event is not fired when player setup errors occur (since these generally occur before the API is ready). Event attributes: 
    220 <ul><li><strong>message</strong> (String): The reason for the error. See <a href="troubleshooting.html">Troubleshooting your Setup</a> for a list of all possible media errors. 
    221 </li></ul></dd></dl> 
    222  
    223  
    224  
    225 <h2>Metadata</h2> 
    226  
    227 <p>This API call allows developers to listen for metadata embedded in the media file (e.g. dimensions of MP4 files or ID3 data of MP3 files).</p> 
    228  
    229 <dl><dt>onMeta(<em>callback</em>)</dt><dd> 
    230 Fired when new metadata has been broadcasted by the player. Event attributes: 
    231 <ul><li><em>metadata</em> (Object): Object containing the new metadata. This can be metadata hidden in the media (XMP, ID3, keyframes) or metadata broadcasted by the playback provider (bandwidth, quality switches). 
    232 </li></ul></dd></dl> 
    233  
    234  
    235  
    236 <h2>Quality</h2> 
     214<h2><a name="quality"></a>Quality</h2> 
    237215 
    238216<p>These API calls are used to listen to or update the video quality if multiple quality levels of a video are provided.</p> 
    … …  
    257235 
    258236 
    259 <h2>Captions</h2> 
     237<h2><a name="captions"></a>Captions</h2> 
    260238 
    261239<p>These API calls are used to listen to or update the currently active captions track, if captions (subtitles) are provided:</p> 
    … …  
    281259 
    282260 
    283 <h2>Button</h2> 
     261<h2><a name="button"></a>Button</h2> 
    284262 
    285263<p>With the button API, it's possible to add buttons to the dock, e.g. for social sharing, video discovery, interface toggles or registrations/logins.</p> 
    … …  
    298276 
    299277 
     278<h2><a name="display"></a>Display</h2> 
     279 
     280<p>This API call allows developers to listen for and react to clicks on the video display.</p> 
     281 
     282<dl><dt>onDisplayClick(<em>callback</em>)</dt><dd> 
     283Fired when a user clicks the video display (not the controls). There are no event attributes. 
     284</li></ul></dd></dl> 
     285 
     286 
     287 
     288 
     289<h2><a name="error"></a>Error</h2> 
     290 
     291<p>This API call allows developers to listen for and react to media playback errors (e.g. when a video URL is not found or a streaming server disconnects).</p> 
     292 
     293<dl><dt>onError(<em>callback</em>)</dt><dd> 
     294Fired when a media playback error has occurred in the player. An error event is not fired when player setup errors occur (since these generally occur before the API is ready). Event attributes: 
     295<ul><li><strong>message</strong> (String): The reason for the error. See <a href="troubleshooting.html">Troubleshooting your Setup</a> for a list of all possible media errors. 
     296</li></ul></dd></dl> 
     297 
     298 
     299 
     300<h2><a name="metadata"></a>Metadata</h2> 
     301 
     302<p>This API call allows developers to listen for metadata embedded in the media file (e.g. dimensions of MP4 files or ID3 data of MP3 files).</p> 
     303 
     304<dl><dt>onMeta(<em>callback</em>)</dt><dd> 
     305Fired when new metadata has been broadcasted by the player. Event attributes: 
     306<ul><li><em>metadata</em> (Object): Object containing the new metadata. This can be metadata hidden in the media (XMP, ID3, keyframes) or metadata broadcasted by the playback provider (bandwidth, quality switches). 
     307</li></ul></dd></dl> 
     308 
     309 
     310 
    300311</body> 
    301312</html> 

  • branches/jw6/doc/scripting.html

    r2308 r2315  
    3030 
    3131<pre> 
    32 &lt;script type="text/javascript" src="http://jwpcdn.com/player.js"&gt;&lt;/script&gt; 
     32&lt;script type="text/javascript" src="/scripts/jwplayer.js"&gt;&lt;/script&gt; 
    3333 
    3434&lt;div id="myElement"&gt;Loading the player ...&lt;/div&gt; 
    … …  
    163163        onResize 
    164164</td></tr><tr><td> 
    165         <a href="script-reference.html#resize">Error</a> 
    166     </td><td> 
    167     </td><td> 
    168     </td><td> 
    169         onError 
    170 </td></tr><tr><td> 
    171         <a href="script-reference.html#metadata">Metadata</a> 
    172     </td><td> 
    173     </td><td> 
    174     </td><td> 
    175         onMeta 
    176 </td></tr><tr><td> 
    177165        <a href="script-reference.html#quality">Quality</a> 
    178166    </td><td> 
    … …  
    201189        removeButton 
    202190    </td><td> 
     191</td></tr><tr><td> 
     192        <a href="script-reference.html#display">Display</a> 
     193    </td><td> 
     194    </td><td> 
     195    </td><td> 
     196        onDisplayClick 
     197</td></tr><tr><td> 
     198        <a href="script-reference.html#resize">Error</a> 
     199    </td><td> 
     200    </td><td> 
     201    </td><td> 
     202        onError 
     203</td></tr><tr><td> 
     204        <a href="script-reference.html#metadata">Metadata</a> 
     205    </td><td> 
     206    </td><td> 
     207    </td><td> 
     208        onMeta 
     209 
    203210</td></tr></table> 
    204211 

  • branches/jw6/doc/skinning.html

    r2308 r2315  
    2828<h2>Introduction</h2> 
    2929 
    30 <p>JW Player skins change the appearance of the player, making it possible to match your embed to your site's aesthetic. No coding skills are required to build a skin, but proficiency with a graphics editor is (e.g. Photoshop or Illustrator).</p> 
     30<p>JW Player skins change the appearance of the player, making it possible to match your video embeds to your site's aesthetic. No coding skills are required to build a skin, but proficiency with a graphics editor is (e.g. Photoshop or Illustrator).</p> 
    3131 
    32 <p>Technically, a JW Player skin consists of an XML file that contains a number of settings (e.g. the <em>fontColor</em>) and a number of links to GIF, JPG or PNG images (e.g. for the <em>playButton</em>). These settings and elements are grouped into 5 components: Controlbar, Display, Dock, Playlist and Tooltip.</p> 
     32<p>Technically, a JW Player skin consists of an XML file that contains a number of settings (e.g. the <em>fontColor</em>) and a number of links to JPG or PNG images (e.g. for the <em>playButton</em>). These settings and elements are grouped into 5 components: Controlbar, Display, Dock, Playlist and Tooltip.</p> 
    3333 
    3434<p>When a skin design is completed, it can be packaged into a single file for faster loading. For Flash, the XML file and PNG images are compressed into a single <strong>ZIP</strong> file. For HTML5, the PNG images are embedded into the <strong>XML</strong> file as base64 encoded strings.</p> 
    … …  
    4646</ul> 
    4747 
    48 <p>The controlbar <strong>layout</strong> block and <strong>volumeSlider</strong> will both still work in JW6, but are considered deprecated. We suggest you update your skins to use the tooltip volumeSlider, and to simply remove controlbar buttons by omitting their elements.</p> 
     48<p>The controlbar <strong>volumeSlider</strong> and <strong>layout</strong> block both still work in JW6, but are considered deprecated. We suggest you update your skins to use the tooltip volumeSlider, and to remove unwanted controlbar buttons by simply omitting their elements.</p> 
    4949 
    5050<h3>Build versus Modify</h3> 
    5151 
    52 <p>This guide contains all information you need to design and package a JW Player skin from scratch. However, an existing skin may already satisfy 90% of your requirements. In that case, we recommend you simply modify an existing skin instead of building one from scratch:</p> 
     52<p>This guide and the accompanying <a href="skin-reference.html">Skin XML Reference</a> contain all info you need to design and package a JW Player skin from scratch. However, an existing skin may already satisfy 90% of your requirements. In that case, we recommend you simply modify an existing skin instead of building one from scratch:</p> 
    5353 
    5454<ul> 
    55 <li>The JW Player <a href="http://www.longtailvideo.com/addons/skins">addons library</a> contains downloads of many skins, including their source files.</li> 
     55<li>The JW Player <a href="http://www.longtailvideo.com/addons/skins">addons pages</a> contain downloads of several skins, including their source files.</li> 
    5656<li>The JW Player <a href="http://developer.longtailvideo.com/trac/browser/skins">developer site</a> contains the source files of all skins within our <em>Premium</em> offering.</li> 
    5757</ul> 
    … …  
    6767<pre> 
    6868&lt;skin version='2' name='SkinName' author='skinAuthor'&gt; 
    69   &lt;components&gt; 
    70     &lt;component name='controlbar'&gt; 
    71       &lt;settings&gt; 
    72         &lt;setting name='...' value='...' /&gt; 
    73         ... 
    74       &lt;/settings&gt; 
    75       &lt;elements&gt; 
    76         &lt;element name='...' src='...' /&gt; 
    77         ... 
    78       &lt;/elements&gt; 
    79     &lt;/component&gt; 
    80     ... 
    81   &lt;/components&gt; 
     69   &lt;components&gt; 
     70      &lt;component name='controlbar'&gt; 
     71         &lt;settings&gt; 
     72            &lt;setting name='...' value='...' /&gt; 
     73            ... 
     74         &lt;/settings&gt; 
     75         &lt;elements&gt; 
     76            &lt;element name='...' src='...' /&gt; 
     77            ... 
     78         &lt;/elements&gt; 
     79      &lt;/component&gt; 
     80      ... 
     81   &lt;/components&gt; 
    8282&lt;/skin&gt; 
    8383</pre> 

  • branches/jw6/doc/skins.html

    r2269 r2315  
    4848<ul> 
    4949<li>We ourselves include a selection of skins with the <a href="http://www.longtailvideo.com/order/">JW Player Premium</a> offering. These skins are all professional looking and tested to work well with many advanced scenarios (like playlists, live streaming and advertising). The same skins are included with our <a href="http://www.longtailvideo.com/bits-on-the-run/">Video Platform</a>.</li> 
    50 <li>Several third-party designers have shared their JW Player skins with us. These are included in our JW Player <a href="http://www.longtailvideo.com/addons/skins">add-ons library</a>. A much greater variety of designs is available here, but not all skins work well in more advanced scenarios (e.g. playlists or small player dimensions).</li> 
     50<li>Several third-party designers have shared their JW Player skins with us. These are included in our JW Player <a href="http://www.longtailvideo.com/addons/skins">add-ons listing</a>. A much greater variety of designs is available here, but not all skins work well in more advanced scenarios (e.g. playlists, tooltips or small dimensions).</li> 
    5151<li>If you are proficient with an image editor (like Photoshop), designing and packaging your own JW Player skin is straightforward. See <a href="skinning.html">Building JW Player Skins</a> for more info.</li> 
    5252</ul> 
    5353 
    54 <p>After downloading (or packaging) the skin of your choice, you are left with its PNG and XML files (e.g. <em>bekle.xml</em> and <em>bekle.zip</em>). Upload these two files to your webserver, so the skin can be configured for your player.</p> 
     54<p>After downloading (or packaging) the skin of your choice, you are left with its XML and ZIP files (e.g. <em>bekle.xml</em> and <em>bekle.zip</em>). Upload these two files to your webserver, so the skin can be configured for your player.</p> 
    5555 
    5656 
    … …  
    7777    height: 360, 
    7878    image: "/uploads/example.jpg", 
    79     skin: "/skins/bekle.zip", 
     79    skin: "/uploads/bekle.zip", 
    8080    width: 640 
    8181}); 

  • branches/jw6/doc/troubleshooting.html

    r2223 r2315  
    4747</ol> 
    4848 
    49 <p>More advanced developers should also take a look at their browser console. The browser may display error messages (e.g. around files not found or CORS errors) that are helpful in tracking down the cause.</p> 
     49<p>More advanced developers should also take a look at their browser console. The browser may display error messages (e.g. around files not found or CORS errors) that are helpful in tracking down the problem.</p> 
    5050 
    5151<h2>1: Player Not Showing At All</h2> 
    … …  
    5454 
    5555<ul> 
    56 <li>Included the &lt;script&gt; tag for loading <strong>jwplayer.js</strong> in the head of your page.</li> 
    57 <li>Included a container &lt;div&gt; with an <strong>id</strong> attribute to load the player into.</li> 
    58 <li>Referred to the correct &lt;div&gt; <strong>id</strong> in the <em>jwplayer(id).setup()</em> call.</li> 
     56<li>Uploaded <strong>jwplayer.js</strong> and included the &lt;script&gt; tag for loading <strong>jwplayer.js</strong> in the head of your page.</li> 
     57<li>Included a container &lt;div&gt; with an <strong>id</strong> attribute and referred to that <strong>id</strong> in the <em>jwplayer(id).setup()</em> call.</li> 
     58<li>Correctly formatted all options in the <em>jwplayer(id).setup()</em> call. We often see issues with commas, brackets or curly braces.</li> 
    5959</ul> 
    6060 
    … …  
    123123<dd>This means the URL to your audio/video file or RTMP/HLS manifest could not be found. Please make sure the file is available at the location you provided (did you set relative paths correctly?) and available for loading in the player (are the access rights and mimetype header set correctly?).</dd> 
    124124<dt>Error loading media: File could not be played</dt> 
    125 <dd>This usually means you are trying to load a file in a nonsupported format in JW Player. A common case is the loading of a <strong>.wmv</strong> video, or a <strong>.mov</strong> video that doesn't use H264 video and AAC audio. See <a href="media.html">Supported Media Formats</a> for the list of formats the player supports.</dd> 
     125<dd>This usually means you are trying to load a file in a nonsupported format in JW Player. A common case is the loading of a <strong>.wmv</strong> video, or a <strong>.mov</strong> video that doesn't use the H264 video codec. See <a href="media.html">Supported Media Formats</a> for the list of formats the player supports.</dd> 
    126126</dl> 
    127127 
    … …  
    137137<dl> 
    138138<dt>Error loading stream: File is not a valid manifest</dt> 
    139 <dd>This means that your SMIL manifest (for RTMP streaming) or M3U8 manifest (for HLS streaming) is not correctly formatted. See <a href="rtmp.html">Using RTMP Streaming</a> or <a href="hls.html">Using HLS Streaming</a> for examples of correctly formatted manifest files.</dd> 
     139<dd>This means that your SMIL manifest (for RTMP streaming) is not correctly formatted. See <a href="rtmp.html">Using RTMP Streaming</a> for examples of correctly formatted manifest files.</dd> 
    140140<dt>Error loading stream: Could not connect to RTMP server</dt> 
    141141<dd>This means that your RTMP server cannot be reached by the player (anymore). Ensure you have setup the correct <strong>streamer</strong> in your configuration options or <strong>base</strong> in your SMIL manifest. Next, ensure your server is actually up and running, and accessible from your computer. The latter is not always the case, since many proxies and firewalls block RTMP traffic. See <a href="rtmp.html">Using RTMP Streaming</a> for more info.</dd> 
    142 <dt>Error loading stream: Flash Player 10.1 is required</dt> 
    143 <dd>In order to play Apple HLS streams (.m3u8), your Flash Player version must be at least 10.1. Please visit <a href="http://get.adobe.com/flashplayer/">the Adobe site</a> to update your Flash player. Note that <a href="http://riastats.com/">a small percentage</a> of desktop browsers still run Flash 10.0 or lower.</dd> 
    144142</dl> 
    145143 
    … …  
    161159<dt>MP4 video seeking is not working</dt> 
    162160<dd>If your MP4 files cannot be seeked before they are completely downloaded, you will have to move your MP4 metadata from the end to the beginning of your MP4 file. Use <a href="http://renaun.com/blog/2010/06/qtindexswapper-2/">this little application</a> to do that.</dd> 
    163 <dt>Apple HLS streams show garbage or black video for a few seconds</dt> 
    164 <dd>The issue here is that JW Player tries to switch from one quality to another, but TS segments do not start with a keyframe. Eventually, the stream will play smooth again, but in order to not have this issue at all your segments should always start with a keyframe. See <a href="">Encoding HLS Streams</a> for more info.</dd> 
    165161</dl> 
    166162 
Note: See TracChangeset for help on using the changeset viewer.