Skip to content

Commit

Permalink
Rename project, reset version and changelog (#6)
Browse files Browse the repository at this point in the history

* rename the project
  • Loading branch information
forbesjo authored Nov 7, 2017
1 parent 2158b75 commit 6e080be
Show file tree
Hide file tree
Showing 23 changed files with 9,152 additions and 29,603 deletions.
520 changes: 2 additions & 518 deletions CHANGELOG.md

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,17 @@ Maintenance Status: Stable

## Installation
### NPM
To install `videojs-contrib-hls` with npm run
To install `videojs-http-streaming` with npm run

```bash
npm install --save videojs-contrib-hls
npm install --save @videojs/http-streaming
```

### CDN
Select a version of HLS from the [CDN](https://cdnjs.com/libraries/videojs-contrib-hls)
Select a version of HLS from the [CDN](https://unpkg.com/@videojs/http-streaming/dist/)

### Releases
Download a release of [videojs-contrib-hls](https://github.com/videojs/videojs-contrib-hls/releases)
Download a release of [videojs-http-streaming](https://github.com/videojs/http-streaming/releases)

### Manual Build
Download a copy of this git repository and then follow the steps in [Building](#building)
Expand All @@ -89,7 +89,7 @@ See [CONTRIBUTING.md](/CONTRIBUTING.md)
Drop by our slack channel (#playback) on the [Video.js slack][slack-link].

## Getting Started
Get a copy of [videojs-contrib-hls](#installation) and include it in your page along with video.js:
Get a copy of [videojs-http-streaming](#installation) and include it in your page along with video.js:

```html
<video id=example-video width=600 height=300 class="video-js vjs-default-skin" controls>
Expand All @@ -98,7 +98,7 @@ Get a copy of [videojs-contrib-hls](#installation) and include it in your page a
type="application/x-mpegURL">
</video>
<script src="video.js"></script>
<script src="videojs-contrib-hls.min.js"></script>
<script src="videojs-http-streaming.min.js"></script>
<script>
var player = videojs('example-video');
player.play();
Expand All @@ -112,11 +112,11 @@ With Video.js 6, by default there is no flash support. Instead, flash support is
through the [videojs-flash](https://github.com/videojs/videojs-flash) plugin. If you are
trying to use Video.js version 6 and want to include flash support, you must include
[videojs-flash](https://github.com/videojs/videojs-flash) on your page before including
videojs-contrib-hls
videojs-http-streaming

```html
<script src="https://unpkg.com/videojs-flash/dist/videojs-flash.js"></script>
<script src="https://unpkg.com/videojs-contrib-hls/dist/videojs-contrib-hls.js"></script>
<script src="https://unpkg.com/@videojs/http-streaming/dist/videojs-http-streaming.js"></script>
```

Flash, and the [videojs-flash](https://github.com/videojs/videojs-flash) plugin, are not
Expand Down Expand Up @@ -151,7 +151,7 @@ Check out the [full documentation](docs/) for details on how HLS works
and advanced configuration. A description of the [adaptive switching
behavior](docs/bitrate-switching.md) is available, too.

videojs-contrib-hls supports a bunch of HLS features. Here
videojs-http-streaming supports a bunch of HLS features. Here
are some highlights:

- video-on-demand and live playback modes
Expand Down Expand Up @@ -278,18 +278,18 @@ cuesTrack.addEventListener('cuechange', function() {
* Type: `boolean`
* can be used as an initialization option

Try to use videojs-contrib-hls even on platforms that provide some
Try to use videojs-http-streaming even on platforms that provide some
level of HLS support natively. There are a number of platforms that
*technically* play back HLS content but aren't very reliable or are
missing features like CEA-608 captions support. When `overrideNative`
is true, if the platform supports Media Source Extensions
videojs-contrib-hls will take over HLS playback to provide a more
videojs-http-streaming will take over HLS playback to provide a more
consistent experience.

__NOTE__: If you use this option, you must also set
`videojs.options.html5.nativeAudioTracks` and
`videojs.options.html5.nativeVideoTracks` to
`false`. videojs-contrib-hls relies on audio and video tracks to play
`false`. videojs-http-streaming relies on audio and video tracks to play
streams with alternate audio and requires additional capabilities only
supported by non-native tracks in video.js.

Expand Down Expand Up @@ -328,9 +328,9 @@ var hls = player.tech({ IWillNotUseThisInPlugins: true }).hls;

If you *were* thinking about modifying runtime properties in a
video.js plugin, we'd recommend you avoid it. Your plugin won't work
with videos that don't use videojs-contrib-hls and the best plugins
with videos that don't use videojs-http-streaming and the best plugins
work across all the media types that video.js supports. If you're
deploying videojs-contrib-hls on your own website and want to make a
deploying videojs-http-streaming on your own website and want to make a
couple tweaks though, go for it!

#### hls.playlists.master
Expand Down Expand Up @@ -395,7 +395,7 @@ adaptive streaming logic.
#### hls.representations
Type: `function`

It is recommended to include the [videojs-contrib-quality-levels](https://github.com/videojs/videojs-contrib-quality-levels) plugin to your page so that videojs-contrib-hls will automatically populate the QualityLevelList exposed on the player by the plugin. You can access this list by calling `player.qualityLevels()`. See the [videojs-contrib-quality-levels project page](https://github.com/videojs/videojs-contrib-quality-levels) for more information on how to use the api.
It is recommended to include the [videojs-contrib-quality-levels](https://github.com/videojs/videojs-contrib-quality-levels) plugin to your page so that videojs-http-streaming will automatically populate the QualityLevelList exposed on the player by the plugin. You can access this list by calling `player.qualityLevels()`. See the [videojs-contrib-quality-levels project page](https://github.com/videojs/videojs-contrib-quality-levels) for more information on how to use the api.

Example, only enabling representations with a width greater than or equal to 720:

Expand Down Expand Up @@ -641,16 +641,16 @@ browsers that karma-detect-browsers detects on your machine.
Check out the [changelog](CHANGELOG.md) for a summary of each release.

## Building
To build a copy of videojs-contrib-hls run the following commands
To build a copy of videojs-http-streaming run the following commands

```bash
git clone https://github.com/videojs/videojs-contrib-hls
cd videojs-contrib-hls
git clone https://github.com/videojs/http-streaming
cd http-streaming
npm i
npm run build
```

videojs-contrib-hls will have created all of the files for using it in a dist folder
videojs-http-streaming will have created all of the files for using it in a dist folder

## Development

Expand All @@ -666,5 +666,5 @@ npm run <command>

[slack-icon]: http://slack.videojs.com/badge.svg
[slack-link]: http://slack.videojs.com
[travis-icon]: https://travis-ci.org/videojs/videojs-contrib-hls.svg?branch=master
[travis-link]: https://travis-ci.org/videojs/videojs-contrib-hls
[travis-icon]: https://travis-ci.org/videojs/http-streaming.svg?branch=master
[travis-link]: https://travis-ci.org/videojs/http-streaming
6 changes: 3 additions & 3 deletions contrib.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"meta": {
"org": "videojs",
"name": "videojs-contrib-hls",
"name": "http-streaming",
"requirements": [
{
"name": "git",
Expand All @@ -13,8 +13,8 @@
}
],
"urls": {
"repo_api": "https://api.github.com/repos/videojs/videojs-contrib-hls",
"repo_ui": "https://github.com/videojs/videojs-contrib-hls"
"repo_api": "https://api.github.com/repos/videojs/http-streaming",
"repo_ui": "https://github.com/videojs/http-streaming"
},
"branches": {
"development": "master",
Expand Down
2 changes: 1 addition & 1 deletion docs/arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The [playlist loader](../src/playlist-loader.js) handles all of the details of r
During VOD playback, the loader will move quickly to the HAVE_METADATA state and then stay there unless a quality switch request sends it to SWITCHING_MEDIA while it fetches an alternate playlist. The loader enters the HAVE_CURRENT_METADATA when a live stream is detected and it's time to refresh the current media playlist to find out about new video segments.

### HLS Tech
Currently, the HLS project integrates with [video.js](http://www.videojs.com/) as a [tech](https://github.com/videojs/video.js/blob/master/docs/guides/tech.md). That means it's responsible for providing an interface that closely mirrors the `<video>` element. You can see that implementation in [videojs-contrib-hls.js](../src/videojs-contrib-hls.js), the primary entry point of the project.
Currently, the HLS project integrates with [video.js](http://www.videojs.com/) as a [tech](https://github.com/videojs/video.js/blob/master/docs/guides/tech.md). That means it's responsible for providing an interface that closely mirrors the `<video>` element. You can see that implementation in [videojs-http-streaming.js](../src/videojs-http-streaming.js), the primary entry point of the project.

### Transmuxing
Most browsers don't have support for the file type that HLS video segments are stored in. To get HLS playing back on those browsers, contrib-hls strings together a number of technologies:
Expand Down
2 changes: 1 addition & 1 deletion examples/multiple-alternative-audio-tracks/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ <h1>Multiple Alternative Audio Tracks</h1>
</select>
</div>
<script src="/node_modules/video.js/dist/video.js"></script>
<script src="/dist/videojs-contrib-hls.js"></script>
<script src="/dist/videojs-http-streaming.js"></script>
<script>
(function(window, videojs) {
var player = window.player = videojs('maat-player');
Expand Down
8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<title>videojs-contrib-hls Demo</title>
<title>videojs-http-streaming Demo</title>
<link href="/node_modules/video.js/dist/video-js.css" rel="stylesheet">
<style>
body {
Expand All @@ -29,7 +29,7 @@
<p>The video below is an <a href="https://developer.apple.com/library/ios/documentation/networkinginternet/conceptual/streamingmediaguide/Introduction/Introduction.html#//apple_ref/doc/uid/TP40008332-CH1-SW1">HTTP Live Stream</a>. On desktop browsers other than Safari, the HLS plugin will polyfill support for the format on top of the video.js Flash tech.</p>
<p>Due to security restrictions in Flash, you will have to load this page over HTTP(S) to see the example in action.</p>
</div>
<video id="videojs-contrib-hls-player" class="video-js vjs-default-skin" controls>
<video id="videojs-http-streaming-player" class="video-js vjs-default-skin" controls>
<source src="https://d2zihajmogu5jn.cloudfront.net/bipbop-advanced/bipbop_16x9_variant.m3u8" type="application/x-mpegURL">
</video>

Expand All @@ -47,10 +47,10 @@
</ul>

<script src="/node_modules/video.js/dist/video.js"></script>
<script src="/dist/videojs-contrib-hls.js"></script>
<script src="/dist/videojs-http-streaming.js"></script>
<script>
(function(window, videojs) {
var player = window.player = videojs('videojs-contrib-hls-player');
var player = window.player = videojs('videojs-http-streaming-player');

// hook up the video switcher
var loadUrl = document.getElementById('load-url');
Expand Down
Loading

0 comments on commit 6e080be

Please sign in to comment.