Skip to content

brainfood / videojs-contrib-hls

Go to a project
Toggle navigation
Toggle navigation pinning
c3fc7e66 by David LaPalomento
Options

Add intro text to the README 

Describe the plugin and current limitations.
1 parent 71246287
Inline Side-by-side
Showing 1 changed file with 45 additions and 11 deletions
...@@ -5,27 +5,61 @@ ...@@ -5,27 +5,61 @@
5 A video.js plugin that plays HLS video on platforms that don't support it but have Flash. 5 A video.js plugin that plays HLS video on platforms that don't support it but have Flash.
6 6
7 ## Getting Started 7 ## Getting Started
8 Download the [production version][min] or the [development version][max]. 8 Download the [plugin](https://raw.github.com/videojs/videojs-contrib-hls/master/dist/videojs-hls.min.js). On your web page:
9
10 [min]: https://raw.bithub.com/dlapalomento/video-js-hls/master/dist/videojs-hls.min.js
11 [max]: https://raw.bithub.com/dlapalomento/video-js-hls/master/dist/videojs-hls.js
12
13 In your web page:
14 9
15 ```html 10 ```html
16 <script src="video.js"></script> 11 <script src="video.js"></script>
17 <script src="dist/videojs-hls.min.js"></script> 12 <script src="videojs-hls.min.js"></script>
18 <script> 13 <script>
19 var player = videojs('video'); 14 var player = videojs('video');
20 player.hls(); 15 player.hls('http://example.com/video.m3u8');
16 player.play();
21 </script> 17 </script>
22 ``` 18 ```
23 19
24 ## Documentation 20 ## Documentation
25 _(Coming soon)_ 21 (HTTP Live Streaming)[https://developer.apple.com/streaming/](HLS) has
22 become a de-facto standard for streaming video on mobile devices
23 thanks to its native support on iOS and Android. There are a number of
24 reasons independent of platform to recommend the format, though:
25
26 - Supports (client-driven) adaptive bitrate selection
27 - Delivered over standard HTTP ports
28 - Simple, text-based manifest format
29 - No proprietary streaming servers required
30
31 Unfortunately, all the major desktop browsers except for Safari are
32 missing HLS support. That leaves web developers in the unfortunate
33 position of having to maintain alternate renditions of the same video
34 and potentially having to forego HTML-based video entirely to provide
35 the best desktop viewing experience.
36
37 This plugin attempts to address that situation by providing a polyfill
38 for HLS on browsers that have Flash support. You can deploy a single
39 HLS stream, code against the regular HTML5 video APIs, and create a
40 fast, high-quality video experience across all the big web device
41 categories.
42
43 The videojs-hls plugin is still working towards a 1.0 release so it
44 may not fit your requirements today. Specifically, there is _no_
45 support for:
46
47 - Alternate audio and video tracks
48 - Subtitles
49 - Dynamic bitrate switching
50 - Segment codecs _other than_ H.264 with AAC audio
51 - Live streams
52 - Internet Explorer 8
26 53
27 ## Examples 54 ## Hosting Considerations
28 _(Coming soon)_ 55 Unlike a native HLS implementation, the HLS plugin has to comply with
56 the browser's security policies. That means that all the files that
57 make up the stream must be served from the same domain as the page
58 hosting the video player or from a server that has appropriate [CORS
59 headers](https://developer.mozilla.org/en-US/docs/HTTP/Access_control_CORS)
60 configured. Easy [instructions are
61 available](http://enable-cors.org/server.html) for popular webservers
62 and most CDNs should have no trouble turning CORS on for your account.
29 63
30 ## Release History 64 ## Release History
31 _(Nothing yet)_ 65 _(Nothing yet)_
......