clappr v0.4.0 Release Notes

Release Date: 2020-06-28 // over 1 year ago
  • โœ… This latest Clappr version brings a lot of breaking changes, it uses the new projects created at the Clappr.org: clappr-core and clappr-plugins.

    ๐Ÿš€ The main repository(https:github.com/clappr/clappr) remains the same for the sake of simplicity, but the modules are deployed into a new scope: the @clappr/player. As you can imagine, the code in @clappr/player is not relevant for most of the Clappr use cases. The current repository contains just a specific code to generate bundles after this release.

    _ The old versions are still available on npm and jsdelivr, but we recommend the use of the @clappr/player module. _

    We re-designed the Clappr architecture to add even more modularity to maintainers and users, we'll dig a little bit about them later here. From now on, instead of having a single repository, we'll have three main projects:

    • ๐Ÿ”Œ The clappr-core: Contains all the essential features from Clappr (its plugin architecture, class abstractions, public interfaces, events handlers, etc).
    • ๐Ÿ”Œ The clappr-plugins: To manage the plugins maintained by the Clappr team.
    • 0๏ธโƒฃ The clappr-player: The entry point for those looking for the main Clappr's distribution, it was built to use this new design, aggregating all the required modules and adding some default plugins.

    ๐Ÿ”Œ The playback plugins are the components that are responsible to play the content, they used to be kept inside the main project, they are now decomposed into separate projects. This means each playback will have its repository, for instance, HLSPlayback. (https://github.com/clappr/hlsjs-playback)

    0๏ธโƒฃ The API of these decoupled playbacks remains the same, as with any other external playbacks (like DashShakaPlayback for instance), however, the HLSPlayback is bundled by default onto the clappr-player's project, which still has the HTML5Playback as well.

    ๐Ÿ”Œ Now when you have issues about Clappr features or you're interested to contribute with Clappr core functionalities or for specific plugins, use the related repository to do so.

    ๐Ÿš€ One breaking change that worth mentioning is related to the use of external plugins/playbacks, you can read the list of changes @clappr/core 0.4.0 version changelog. We'll keep adding, ASAP, examples to demonstrate how to migrate plugins from the version 0.3.x to the 0.4.x on the wiki.

    ๐Ÿ“š We also want to create a new documentation site to aggregate all the Clappr's projects, but it's still in the conception process. If the READMEs/Wikis doesn't help with your issue, open an issue so we can help!

    ๐Ÿš€ We're planning to launch the 1.0.0 stable version of Clappr soon but when we do that, we'll probably write another document describing which repositories will be affected by the release.

    For any questions, contact us!