Wondering what’s next for npm?Check out our public roadmap! »

    @pakhshkit-js/pakhshkit-js-dash

    1.24.3 • Public • Published

    PakhshKit JS DASH - Shaka Player Adapter for the PakhshKit JS Player

    Build Status code style: prettier

    PakhshKit JS DASH adapter integrates Shaka Player with the PakhshKit JS Player.

    PakhshKit JS DASH is written in ECMAScript6, statically analysed using Flow and transpiled in ECMAScript5 using Babel.

    Getting Started

    Prerequisites

    The adapter requires PakhshKit JS Player to be loaded first.

    The adapter uses the Shaka Player javascript library.

    Installing

    First, clone and run yarn to install dependencies:

    git clone https://gitlab.com/kontorol/pakhshkit-js-dash.git
    cd pakhshkit-js-dash
    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/pakhshkit.js"></script>
    <script type="text/javascript" src="/PATH/TO/FILE/pakhshkit-dash.js"></script>
    <div id="player-placeholder" style="height:360px; width:640px">
      <script type="text/javascript">
        var playerContainer = document.querySelector("#player-placeholder");
        var config = {...};
        var player = pakhshkit.core.loadPlayer(config);
        playerContainer.appendChild(player.getView());
        player.play();
      </script>
    </div>

    Configuration

    Shaka Player configuration options, documented @Shaka Player API docs, can be passed via the PakhshKit JS Player config.

    The configuration is exposed via the playback section:

    {
      playback: {
        options: {
          html5: {
            dash: {
              // Shaka Player configuration options here
            }
          }
        }
      }
    }

    Running the tests

    Tests can be run locally via Karma, which will run on Chrome, Firefox and Safari

    yarn run test
    

    You can test individual browsers:

    yarn run test:chrome
    yarn run test:firefox
    yarn run test:safari
    

    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.

    Compatibility

    TBD

    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

    Install

    npm i @pakhshkit-js/pakhshkit-js-dash

    DownloadsWeekly Downloads

    7

    Version

    1.24.3

    License

    AGPL-3.0

    Unpacked Size

    224 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar