npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@playkit-js/playkit-js-dual-screen

v3.1.40

Published

[![Build Status](https://github.com/kaltura/playkit-js-dual-screen/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-dual-screen/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.

Downloads

333

Readme

PlayKit JS Dual Screen - Dual Screen plugin for the [PlayKit JS Player]

Build Status code style: prettier

PlayKit JS Dual Screen is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.

Getting Started

Prerequisites

The plugin requires Kaltura Player to be loaded first.

Installing

First, clone and run yarn to install dependencies:

git clone https://github.com/kaltura/playkit-js-dual-screen.git
cd playkit-js-dual-screen
yarn install

Building

Then, build the player

yarn run build

Embed the library in your test page

Finally, add the bundle as a script tag in your page, and initialize the player

<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Kaltura player-->
<script type="text/javascript" src="/PATH/TO/FILE//playkit-kaltura-cuepoints.js"></script>
<!--PlayKit cuepoint plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-dual-screen.js"></script>
<!--PlayKit dual screen plugin-->
<div id="player-placeholder" style="height:360px; width:640px">
  <script type="text/javascript">
    var playerContainer = document.querySelector("#player-placeholder");
    var config = {
     ...
     targetId: 'player-placeholder',
     plugins: {
      dualscreen: { ... },
      kalturaCuepoints: { ... },
     }
     ...
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Documentation

Dual screen plugin configuration can been found here:

Dual screen plugin dependencies can been found here:

Slides configuration

If you are showing slides, you MUST also include kalturaCuePoints plugin in the configuration as follow -

plugins: { dualscreen: {...}, kalturaCuepoints: { } }

And coding style tests

We use ESLint recommended set with some additions for enforcing [Flow] types and other rules.

See ESLint config for full configuration.

We also use .editorconfig to maintain consistent coding styles and settings, please make sure you comply with the styling.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details

Configuration

DualScreenConfigObject

Defines the configuration of the dual screen. Except childSizePercentage, the configuration only defines the appearance when the player loads. After that, the user can adjust and change it.

Configuration Structure

//Default configuration
"dualscreen" = {};
//Plugin params
"dualscreen" = {
  position?: string, // optional
  layout?: string, // optional
  childSizePercentage?: number, // optional
  slidesPreloadEnabled?: boolean, // optional
  childAspectRatio?: { // optional
    width: number,
    height: number
  }
}

config.position

Type: string
Default: bottom-right
Description: ("bottom-left" | "bottom-right" | "top-left" | "top-right") The position where the child player will be displayed.

config.layout

Type: string
Default: PIP
Description: ("PIP" | "PIPInverse" | "SingleMedia" | "SingleMediaInverse" | "SideBySide" | "SideBySideInverse") The layout of the parent and child players.

config.childSizePercentage

Type: number
Default: 30
Description: Relevant only for PIP layout - Sets the height of the child player as percentage of the parent player height.

config.slidesPreloadEnabled

Type: boolean
Default: true
Description: Enable image preloading

config.childAspectRatio

Type: Object<width: number, height: number>
Default: { width: 16, height: 9 }
Description: set aspect ration for PIP container

config.removePlayerSettings

Type: boolean
Default: false
Description: removes media settings from player if dual-screen layout active

Dependencies

Plugin dependencies: Cue Points