Have ideas to improve npm?Join in the discussion! »

    @playkit-js/playkit-js-vr

    2.0.2-canary.1-999e33a • Public • Published

    PlayKit JS VR - VR plugin for the PlayKit JS Player

    Build Status code style: prettier

    PlayKit JS VR is written in ECMAScript6, statically analysed using Flow and transpiled in ECMAScript5 using Babel.

    Getting Started

    Prerequisites

    The plugin requires PlayKit JS Player to be loaded first.

    Installing

    First, clone and run yarn to install dependencies:

    git clone https://github.com/kaltura/playkit-js-vr.git
    cd playkit-js-vr
    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/playkit.js"></script>
    <!--PlayKit player-->
    <script type="text/javascript" src="/PATH/TO/FILE/playkit-vr.js"></script>
    <!--PlayKit VR plugin-->
    <div id="player-placeholder" style="height:360px; width:640px">
      <script type="text/javascript">
        var playerContainer = document.querySelector("#player-placeholder");
        var config = {
         ...
         plugins: {
           vr: {
             toggleStereo: true
           }
         }
         ...
        };
        var player = playkit.core.loadPlayer(config);
        playerContainer.appendChild(player.getView());
        player.play();
      </script>
    </div>

    Documentation

    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 @playkit-js/[email protected]

    Version

    2.0.2-canary.1-999e33a

    License

    AGPL-3.0

    Unpacked Size

    2.46 MB

    Total Files

    9

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar