Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceebluetv/videojs-plugins
Video.js plugins to play streams hosted on the Ceeblue cloud platform.
https://github.com/ceebluetv/videojs-plugins
cdn dash fallback hls live ll-hls real-time streaming video webrtc whep whip
Last synced: 2 months ago
JSON representation
Video.js plugins to play streams hosted on the Ceeblue cloud platform.
- Host: GitHub
- URL: https://github.com/ceebluetv/videojs-plugins
- Owner: CeeblueTV
- License: agpl-3.0
- Created: 2024-02-13T10:14:14.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T08:55:35.000Z (3 months ago)
- Last Synced: 2024-10-11T17:21:16.532Z (2 months ago)
- Topics: cdn, dash, fallback, hls, live, ll-hls, real-time, streaming, video, webrtc, whep, whip
- Language: JavaScript
- Homepage: https://ceeblue.net
- Size: 1.9 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# videojs-plugins
[](https://npmjs.org/package/@ceeblue/videojs-plugins)
Set of [Videojs] plugins for playing streams from the [Ceeblue] cloud.
This plugin contains:
- **[WebRTCSource](#webrtcsource)**, a [Videojs] WebRTC playback source handler supporting [WHEP] and the Ceeblue WebSocket custom signaling,
- **[QualityButton](#qualitybutton)**, a plugin to select the video quality for any kind of source implementing [videojs-contrib-quality-levels],
- **[SourceController](#sourcecontroller)**, a utility class to switch automatically from one Ceeblue source to another (including WebRTC, HLS, LLHLS and DASH)
## Table of Contents
- [Installation](#installation)
- [WebRTCSource](#webrtcsource)
- [Parameters](#parameters)
- [**src**](#src)
- [**type**](#type)
- [**iceserver**](#iceserver)
- [**audiobutton**](#audiobutton)
- [**data**](#data)
- [Source Object](#source-object)
- [`` HTML tag](#source-html-tag)
- [QualityButton](#qualitybutton)
- [SourceController](#sourcecontroller)
- [Disabling QualityButton](#disabling-qualitybutton)
- [Examples](#examples)
- [Documentation](#documentation)
- [Contribution](#contribution)
- [License](#license)
## Installation
Download the package from [@ceeblue/videojs-plugins][npm-url] or build it manually from the [github sources][github-sources]:
```sh
npm install
npm run build
```
Include [@ceeblue/videojs-plugins][npm-url] in your HTML code as usual with the link to [Videojs] and this library.
Example:
```html
```
## WebRTCSource
### Parameters
#### **src**
The `src` field contains the URL of the WebRTC endpoint.
The protocol can be WebSocket (`wss`) to get the best of the custom Ceeblue signaling or HTTP (`https`) to use the standard WHEP signaling protocol.
Here is the expected format:
```js
[wss|https]://[/]/[?id=][&audio=][&video=]
```
And here is an example of a WebSocket URL:
```js
wss://la-8.live.ceeblue.tv/as+12346f7c-e5db-450b-9603-c3644274779b
```
The following options can be set in the query:
- **id** The access token in case the stream is private.
- **audio** the audio track ID or `none` to disable audio.
- **video** the video track ID or `none` to disable video.
#### **type**
**It is important for the MIME-type to be empty to use the WebRTC source.**
#### **iceserver**
[Ice-server](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection#iceservers) structure in JSON string format with TURN URL used to establish the WebRTC connection, mainly for TCP fallback.
> Do not enclose the object in an array.
> If you have multiple TURN servers, you can add them in the `urls` array.
> **If not set, the plugin will use the default TURN server**
**Example:**
> Replace `` by your endpoint hostname
```js
{
"urls": ["turn:?transport=tcp", "turn::3478"],
"username": "csc_demo",
"credential": "UtrAFClFFO"
}
```
#### **audiobutton**
`false` to disable the WebRTC audio track selection button, `true` by default.
#### **data**
`true` to listen to all timed metadata tracks, `false` otherwise. `true` by default.
> This has no effect on the player, to get the timed metadata in your application you need to use the [textTracks() API](https://videojs.com/guides/text-tracks/) of [Videojs], you can check [examples/player.html](./examples/player.html) for a usage example.
### Source Object
Call the `player.src()` method with a WebRTC URL.
**Example:**
> Replace `` by your endpoint hostname and `` by your stream name.
```html
import {} from "/path/to/video.min.js";
import {} from "/path/to/ceeblue/videojs-plugins.min.js";
...
const player = videojs('video-tag');
player.src({
src: 'wss://<host>/<streamName>',
iceserver: '{
"urls": ["turn:<host>?transport=tcp", "turn:<host>:3478"],
"username": "csc_demo",
"credential": "UtrAFClFFO"
}',
audiobutton: true,
data: false
});
player.start();
```
### `` HTML tag
The WebRTC source can be set directly in the HTML Source tag.
**Example:**
> Replace `` by your endpoint hostname and `` by your stream name.
```html
var player = videojs('video-player');
```
## QualityButton
If you are not using the [SourceController](#sourcecontroller), the QualityButton plugin can be called with a simple command to create the video menu button using the qualityLevels of the current source (see [videojs-contrib-quality-levels]):
```html
var player = videojs('video-player');
player.qualityButton();
```
## SourceController
The [SourceController](./src/controllers/SourceController.js) allows you to configure fallback sources if the current source is not working (for example, if WebRTC is not supported in the browser).
It is also used for seamlessly switching from one source to the other.
The constructor of `SourceController` takes three arguments :
- The videojs player,
- The `Connect.Params`, the ceeblue connection parameters (see [Connect class]),
- The list of sources in order of priority. A source can be a string from the `SourceType` list or a [Source Object] in order to set custom options.
To start the `SourceController` call the `start()` function with the `SourceType` to start with, or no argument to start from the first source.
> The `SourceType` object in [SourceController.js](./src/controllers/SourceController.js) defines the list of possible sources,
> The [Source object] must have the `src` field and the `type` field set to the MIME type of the source (empty for WebRTC, see [WebRTCSource](#webrtcsource)).
**Example:**
> Replace `` by your endPoint, `host` by the endPoint hostname and `` by your stream name.
```javascript
const sourceController = new SourceController(
player
);
sourceController.on('sourcechanged', (source) => {
console.log('sourcechanged', source); // null means no more sources available
});
sourceController.start(
{
endPoint: '',
streamName: ''
query: 'id='
},
[
{
// A WebRTC source with custom options
src: 'wss:///',
iceserver: '{"urls": ["turn:?transport=tcp", "turn::3478"], "username": "csc_demo", "credential": "UtrAFClFFO"}',
},
'llhls',
'dash',
{
// A fallback source with a custom type
src: 'http://vjs.zencdn.net/v/oceans.mp4',
type: 'video/mp4'
}
]);
```
### Disabling QualityButton
By default the SourceController creates a [QualityButton](#qualitybutton) for the current source but you can disable it in the player's options with the `qualityButton` option:
```javascript
const player = videojs(videoEl, { qualityButton: false});
```
## Examples
Examples can be found in the [examples/](./examples/) directory:
- **player.html** An advanced example using WebRTC, the [SourceController](#sourcecontroller), and the [QualityButton](#qualitybutton), with a UI for setting parameters and displaying timed metadata.
- **simple-player.html** A simple example using [SourceController](#sourcecontroller) with default parameters.
- **webrtc-player.html** A simple example with a WebRTC source configured with the HTML `` tag.
All examples include the HTML code to include the library and player, and the JavaScript code to configure the player.
You can add query parameters to the URL to test the different options.
For example:
> Replace `` with your endpoint host name, `` with your stream name, and `` with the
viewer access token provided by the Ceeblue Cloud API (optional, only if the stream is private).
```html
https://localhost:8080/examples/player.html?host=&stream=&accessToken=
```
## Documentation
This monorepo also contains built-in documentation about the APIs in the library, which can be built using the following npm command:
```shell
npm run docs
```
Open the index.html file in the docs folder with your browser to access the documentation. (`./docs/api/index.html`).
## Contribution
All contributions are welcome. Please see [our contribution guide](/CONTRIBUTING.md) for details.
## License
By contributing code to this project, you agree to license your contribution under the [GNU Affero General Public License](/LICENSE).
[ceeblue]: https://ceeblue.net/
[Connect class]: https://github.com/CeeblueTV/web-utils/blob/main/src/Connect.ts
[github-sources]: https://github.com/CeeblueTV/videojs-plugins
[npm-url]: https://www.npmjs.com/package/@ceeblue/videojs-plugins
[Source Object]: https://www.w3schools.com/JSREF/dom_obj_source.asp
[videojs]: https://videojs.com/
[videojs-options]: https://videojs.com/guides/options
[videojs-contrib-quality-levels]: https://github.com/videojs/videojs-contrib-quality-levels
[WHEP]: https://datatracker.ietf.org/doc/draft-murillo-whep/