rx-player 4.0.0 → 4.1.0-dev.2024031100

package/MAINTAINERS.md

@@ -1,28 +1,25 @@
-# Maintainers ##################################################################
+# Maintainers
 
-This file contains information about current and previous maintainers, which are
-the people allowed to update directly the code of the RxPlayer library and its
-associated tools.
+This file contains information about current and previous maintainers, which are the
+people allowed to update directly the code of the RxPlayer library and its associated
+tools.
 
 Note that there are other external contributors which are not listed here. Their
 contributions had to be validated and merged by a maintainer.
 
-Please do not contact the people in this file to report an issue, ask an
-RxPlayer-related question or to propose new features.
+Please do not contact the people in this file to report an issue, ask an RxPlayer-related
+question or to propose new features.
 
-
-## Current maintainers #########################################################
+## Current maintainers
 
 Here is the list of current maintainers:
 
 - Paul Berberian <paul.berberian@canal-plus.com>
 - Florent Bouisset <florent.bouisset@canal-plus.com>
 
+## Previous maintainers
 
-## Previous maintainers ########################################################
-
-Here is the list of previous maintainers, which are not working on the project
-anymore:
+Here is the list of previous maintainers, which are not working on the project anymore:
 
 - Achraf Laamoum <achraf.laamoum@canal-plus.com>
 - Alexandre Duros <alexandre.duros@canal-plus.com>

package/README.md

@@ -28,72 +28,71 @@
   </a>
 </p>
 
-The RxPlayer is a library implementing a [DASH](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP)
-and [Microsoft Smooth Streaming](https://en.wikipedia.org/wiki/Adaptive_bitrate_streaming#Microsoft_Smooth_Streaming)
+The RxPlayer is a library implementing a
+[DASH](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP) and
+[Microsoft Smooth Streaming](https://en.wikipedia.org/wiki/Adaptive_bitrate_streaming#Microsoft_Smooth_Streaming)
 media player on a browser, by relying on the HTML5
-[Media Source Extensions](https://en.wikipedia.org/wiki/Media_Source_Extensions)
-and [Encrypted Media extensions](https://en.wikipedia.org/wiki/Encrypted_Media_Extensions)
+[Media Source Extensions](https://en.wikipedia.org/wiki/Media_Source_Extensions) and
+[Encrypted Media extensions](https://en.wikipedia.org/wiki/Encrypted_Media_Extensions)
 browser APIs.
 
 ---
 
-Originally designed to power Canal+ many applications, the RxPlayer is today
-used in production by several companies in multiple countries and runs on most
-devices where a browser can run: Computers, phones, set-top-boxes, smart TVs,
-game consoles and other peculiar environments are all supported and able to
-profit from its many features.
+Originally designed to power Canal+ many applications, the RxPlayer is today used in
+production by several companies in multiple countries and runs on most devices where a
+browser can run: Computers, phones, set-top-boxes, smart TVs, game consoles and other
+peculiar environments are all supported and able to profit from its many features.
 
 Its main goals are:
 
-  - __Stability__: The RxPlayer can play live and On Demand DASH and Smooth
-    contents for extended amounts of time, with or without DRM - without any
-    performance, memory or logic issue.
+- **Stability**: The RxPlayer can play live and On Demand DASH and Smooth contents for
+  extended amounts of time, with or without DRM - without any performance, memory or logic
+  issue.
 
-    If you encounter a new issue while using it, we'll be very happy to help
-    fixing it. Any encountered bug is put at high priority.
+  If you encounter a new issue while using it, we'll be very happy to help fixing it. Any
+  encountered bug is put at high priority.
 
-  - __Quality of experience__: It aims to play the best possible quality
-    without any rebuffering.
+- **Quality of experience**: It aims to play the best possible quality without any
+  rebuffering.
 
-    Unsupported codecs and undecipherable qualities (e.g. higher qualities with
-    more drastic DRM conditions on untrusted devices) are automatically
-    filtered out, even if this happens during playback.
+  Unsupported codecs and undecipherable qualities (e.g. higher qualities with more drastic
+  DRM conditions on untrusted devices) are automatically filtered out, even if this
+  happens during playback.
 
-    The player is also very resilient: any temporary network issue, fall in
-    bandwidth, poorly-packaged content or platform quirk should be properly
-    handled with the main goal of avoiding playback interruption.
+  The player is also very resilient: any temporary network issue, fall in bandwidth,
+  poorly-packaged content or platform quirk should be properly handled with the main goal
+  of avoiding playback interruption.
 
-  - __Portability__: The RxPlayer has been ported to a lot of devices, some on
-    the lower-end of performance and memory capabilities and others on the higher end.
+- **Portability**: The RxPlayer has been ported to a lot of devices, some on the lower-end
+  of performance and memory capabilities and others on the higher end.
 
-    As such, it can adapt to important memory and performance constraints while
-    still being able to retain its many features.
+  As such, it can adapt to important memory and performance constraints while still being
+  able to retain its many features.
 
-  - __Configurability__: The RxPlayer has a plethora of options to let you tweak
-    its behavior.
-    You should be able to play any content the way you want, on any device.
+- **Configurability**: The RxPlayer has a plethora of options to let you tweak its
+  behavior. You should be able to play any content the way you want, on any device.
 
-    You should also be able to integrate complex supplementary logic like
-    Peer-to-Peer solutions.
+  You should also be able to integrate complex supplementary logic like Peer-to-Peer
+  solutions.
 
-  - __Easy to use__: We try hard to make this player easy to integrate and to
-    use in various codebases.
+- **Easy to use**: We try hard to make this player easy to integrate and to use in various
+  codebases.
 
-    Even for the more advanced options, we aim to make our documentation as
-    legible and as complete as possible.
+  Even for the more advanced options, we aim to make our documentation as legible and as
+  complete as possible.
 
 The RxPlayer has probably already all the features you want :)!
 
-Even if that's not the case, we will be very pleased to exchange with you on it
-and look forward for external contributions.
+Even if that's not the case, we will be very pleased to exchange with you on it and look
+forward for external contributions.
 
+## How to use it?
 
-## How to use it? ##############################################################
-
-The fastest way to use the player directly in your code is to add this
-repository as a dependency.
+The fastest way to use the player directly in your code is to add this repository as a
+dependency.
 
 You can do it via [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/):
+
 ```sh
 # when using npm:
 npm install --save rx-player
@@ -103,6 +102,7 @@ yarn add rx-player
 ```
 
 You can then directly import and use the RxPlayer in your code:
+
 ```js
 // import it ES6 style:
 import RxPlayer from "rx-player";
@@ -112,37 +112,39 @@ import RxPlayer from "rx-player";
 
 // instantiate it
 const player = new RxPlayer({
-  videoElement: document.querySelector("video")
+  videoElement: document.querySelector("video"),
 });
 
 // play a video
 player.loadVideo({
   url: "http://vm2.dashif.org/livesim-dev/segtimeline_1/testpic_6s/Manifest.mpd",
   transport: "dash",
-  autoPlay: true
+  autoPlay: true,
 });
 ```
 
 We've also written short tutorials to help you familiarize with the RxPlayer API:
-  - [Quick start into the API](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Quick_Start.html).
-  - [Playing contents with DRMs](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Content_with_DRM.html).
-  - [Selecting a track](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Selecting_a_Track.html)
-  - [Listening to events contained in the content](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/EventStream_Handling.html)
 
-To be able to play with the player without needing to perform any setup we also
-created multiple live-editable demos:
- - [Playing a clear DASH content](https://codesandbox.io/s/rx-player-classic-wc38j)
- - [Playing an encrypted DASH content](https://codesandbox.io/s/rx-player-drm-g51hb)
- - [Playing an RxPlayer-specific MetaPlaylist content](https://codesandbox.io/s/rx-player-metaplaylist-l0t0d)
+- [Quick start into the API](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Quick_Start.html).
+- [Playing contents with DRMs](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Content_with_DRM.html).
+- [Selecting a track](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Selecting_a_Track.html)
+- [Listening to events contained in the content](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/EventStream_Handling.html)
+
+To be able to play with the player without needing to perform any setup we also created
+multiple live-editable demos:
 
-### Minimal Builds #############################################################
+- [Playing a clear DASH content](https://codesandbox.io/s/rx-player-classic-wc38j)
+- [Playing an encrypted DASH content](https://codesandbox.io/s/rx-player-drm-g51hb)
+- [Playing an RxPlayer-specific MetaPlaylist content](https://codesandbox.io/s/rx-player-metaplaylist-l0t0d)
 
-To reduce the size of the final code, you might also want to import a minimal
-version of the player and only import the features you need. This is documented
-[here
-](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Minimal_Player.html):
+### Minimal Builds
+
+To reduce the size of the final code, you might also want to import a minimal version of
+the player and only import the features you need. This is documented
+[here ](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Minimal_Player.html):
 
 For example, to play encrypted DASH contents, you could just write:
+
 ```js
 import RxPlayer from "rx-player/minimal";
 import { DASH, EME } from "rx-player/features";
@@ -151,11 +153,10 @@ import { DASH, EME } from "rx-player/features";
 RxPlayer.addFeatures([DASH, EME]);
 ```
 
+## API
 
-## API #########################################################################
-
-We documented the API in every little details in [the API
-documentation](https://developers.canal-plus.com/rx-player/doc/api/Overview.html).
+We documented the API in every little details in
+[the API documentation](https://developers.canal-plus.com/rx-player/doc/api/Overview.html).
 
 You can also refer to the documentation of our previous versions
 [here](https://developers.canal-plus.com/rx-player/documentation_pages_by_version.html)
@@ -163,101 +164,85 @@ You can also refer to the documentation of our previous versions
 These documentation pages are automatically generated from the content of the
 [doc/api](./doc/api/Overview.md) directory in this repository.
 
-
-
-## Demo ########################################################################
+## Demo
 
 You can view our online Demo, built from our last version,
 [here](https://developers.canal-plus.com/rx-player/).
 
-This demo is a small application written in
-[React](https://github.com/facebook/react) demonstrating a simple usage of the
-player.
+This demo is a small application written in [React](https://github.com/facebook/react)
+demonstrating a simple usage of the player.
 
 Demo pages for our previous versions are also available
 [here](https://developers.canal-plus.com/rx-player/demo_page_by_version.html).
 
+## Contribute
 
+Details on how to contribute is written in the [CONTRIBUTING.md file](./CONTRIBUTING.md)
+at the root of this repository.
 
-## Contribute ##################################################################
-
-Details on how to contribute is written in the [CONTRIBUTING.md
-file](./CONTRIBUTING.md) at the root of this repository.
-
-
-
-### Dependencies ###############################################################
+### Dependencies
 
 After cloning our repo, you should first install our dependencies via either
 [npm](https://www.npmjs.com/):
+
 ```sh
 npm install
 ```
 
+## Why a new player?
 
-## Why a new player? ###########################################################
+### A need for an advanced media player
 
-### A need for an advanced media player ########################################
+Canal+ Group is a media company with many advanced needs when it comes to media playback:
+it provides both live and VoD stream with multiple encryption requirements, supports a
+very large panel of devices and has many other specificities (like adult content
+restrictions, ad-insertion, Peer-To-Peer integration, low-latency live streaming...).
 
-Canal+ Group is a media company with many advanced needs when it comes to media
-playback: it provides both live and VoD stream with multiple encryption
-requirements, supports a very large panel of devices and has many other
-specificities (like adult content restrictions, ad-insertion, Peer-To-Peer
-integration, low-latency live streaming...).
+When the time came to switch from a plugin-based web player approach to an HTML5 one back
+in 2015, no media player had the key features we wanted, and including those needs into an
+already existing media player would not be straightforward either.
 
-When the time came to switch from a plugin-based web player approach to an HTML5
-one back in 2015, no media player had the key features we wanted, and including
-those needs into an already existing media player would not be straightforward
-either.
+The R&D department of Canal+ Group thus started to work on a new featureful media-player:
+the RxPlayer. To both help and profit from the community, it also decided to share it to
+everyone under a permissive open-source licence.
 
-The R&D department of Canal+ Group thus started to work on a new featureful
-media-player: the RxPlayer. To both help and profit from the community, it also
-decided to share it to everyone under a permissive open-source licence.
-
-Now, more than 8 years later, the RxPlayer continues to evolve at the same fast
-pace to include a lot of features and improvements you may not find in other
-media players.
-You can look at our
+Now, more than 8 years later, the RxPlayer continues to evolve at the same fast pace to
+include a lot of features and improvements you may not find in other media players. You
+can look at our
 [API documentation](https://developers.canal-plus.com/rx-player/doc/api/Overview.html),
 [tutorials](https://developers.canal-plus.com/rx-player/doc/Getting_Started/Tutorials/Quick_Start.html)
-and our [demo page](https://developers.canal-plus.com/rx-player/)
-(an RxPlayer instance is available in the console through the global `player`
-variable there) to see if it matches your need.
-
+and our [demo page](https://developers.canal-plus.com/rx-player/) (an RxPlayer instance is
+available in the console through the global `player` variable there) to see if it matches
+your need.
 
-### A featureful player ########################################################
+### A featureful player
 
-With the help of a carefully-crafted and well-documented architecture, we were
-able to quickly support avanced features when we - or the community - needed
-them. Amongst those:
+With the help of a carefully-crafted and well-documented architecture, we were able to
+quickly support avanced features when we - or the community - needed them. Amongst those:
 
-  - support for live and VoD DASH / Smooth / HLS* / Downloaded contents /
-    MP4* / WebM* contents and more
+- support for live and VoD DASH / Smooth / HLS* / Downloaded contents / MP4* / WebM\*
+  contents and more
 
-  - support of advanced encryption configuration, such as multiple keys in a
-    single or separate licences for a given content (with automatic fallbacks
-    when we found an un-decipherable content), persistent licenses, and
-    other device-specific restrictions.
+- support of advanced encryption configuration, such as multiple keys in a single or
+  separate licences for a given content (with automatic fallbacks when we found an
+  un-decipherable content), persistent licenses, and other device-specific restrictions.
 
-  - support for low-latency DASH streams
+- support for low-latency DASH streams
 
-  - support of TTML, WebVTT, SAMI and SRT subtitles
+- support of TTML, WebVTT, SAMI and SRT subtitles
 
-  - an available WebAssembly-based MPD parser for DASH contents, allowing to
-    drastically reduce the loading time and memory usage of larger contents.
+- an available WebAssembly-based MPD parser for DASH contents, allowing to drastically
+  reduce the loading time and memory usage of larger contents.
 
-  - advanced APIs for advanced use-cases (audio-only mode, video track
-    selection, manual garbage collection of segments, Peer-To-Peer
-    integration, quality filtering...)
+- advanced APIs for advanced use-cases (audio-only mode, video track selection, manual
+  garbage collection of segments, Peer-To-Peer integration, quality filtering...)
 
-  - advanced adaptive streaming algorithms making use of both a network-based
-    approach (for quick start-up) and a buffer-based one (to provide the best
-    quality possible).
+- advanced adaptive streaming algorithms making use of both a network-based approach (for
+  quick start-up) and a buffer-based one (to provide the best quality possible).
 
-  - advanced optimizations for devices with low memory constraints
+- advanced optimizations for devices with low memory constraints
 
-  - a complex segment scheduling logic, prioritizing closer media segments while
-    making sure that the bandwidth usage is always optimal and the rebuffering
-    risks always low.
+- a complex segment scheduling logic, prioritizing closer media segments while making sure
+  that the bandwidth usage is always optimal and the rebuffering risks always low.
 
 \* In "directfile" mode, on compatible browsers

package/VERSION

@@ -1 +1 @@
-4.0.0
+4.1.0-dev.2024031100