This plugin extends the pillarbox-web player with playlist management capabilities. It allows to load, manage, and control playback of a sequence of videos with options for auto-advancing, repeating content, and dynamic playlist modification.

To use this plugin, you need the following installed on your system:

• Node.js

To get started with this plugin, follow these steps:

Add the @srgssr registry to your .npmrc file:

//npm.pkg.github.com/:_authToken=TOKEN
@srgssr:registry=https://npm.pkg.github.com

Generate a personal access token on the [Personal Access Tokens page][token-settings]. For more information on using tokens with GitHub packages, visit: [Authenticating with a Personal Access Token][token-guide].

You can now install it through npm the following command:

npm install --save @srgssr/pillarbox-web @srgssr/pillarbox-playlist

For instructions on setting up Pillarbox, see the Quick Start guide.

Once the player is installed you can activate the plugin as follows:

import Pillarbox from '@srgssr/pillarbox-web';
import '@srgssr/pillarbox-playlist';
import '@srgssr/pillarbox-playlist/ui';

const player = new Pillarbox('my-player', {
  plugins: { 
    pillarboxPlaylist: { autoadvance: true, repeat: true },
    pillarboxPlaylistUI: { insertChildBefore: 'fullscreenToggle' }
  }
});

const playlist = [
  { sources: [{ src: 'video1.mp4', type: 'video/mp4' }], poster: 'poster1.jpg' },
  { sources: [{ src: 'video2.mp4', type: 'video/mp4' }], poster: 'poster2.jpg' }
];

player.playlistPlugin().load(playlist);

To apply the default styling, add the following line to your CSS file:

@import "@srgssr/pillarbox-playlist/dist/pillarbox-playlist.min.css";

[!TIP] To opt-out of the default UI, simply remove the pillarboxPlaylistUI plugin from the player configuration.

The following table outlines the key methods available in the this plugin:

When initializing the playlist plugin, you can pass an options object that configures the behavior of the plugin. Here are the available options:

After initializing the plugin, you can modify or read these properties to control playlist behavior dynamically:

The following properties are read-only:

The following event is emitted by the playlist plugin:

Event Payload:

Example Usage:

player.playlistPlugin().on('statechanged', ({ changes }) => {
  if ('items' in changes) {
    // React to 'items' changes
  }

  if ('currentIndex' in changes) {
    // React to 'currentIndex' changes
  }
});

For detailed contribution guidelines, refer to the main project’s README file. Please adhere to the specified guidelines.

Start the development server:

npm run start

This will start the server on http://localhost:4200. Open this URL in your browser to view the demo page.

The video player (player) and the Pillarbox library (pillarbox) are exposed on the window object, making it easy to access and manipulate from the browser's developer console for debugging.

The demo page supports several URL parameters that modify the behavior of the video player:

• debug: Set this to enable debugging mode.
• ilHost: Specifies the host for the data provider.
• language: Sets the language for the player interface.

You can combine parameters in the URL like so:

http://localhost:4200/?language=fr

This project is licensed under the MIT License. See the LICENSE file for more details.