javascript framework that implements Roundware api/2/
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
docs
example
spec
src
.gitignore
.travis.yml
AUTHORS.md
CODE_OF_CONDIUCT.md
COPYRIGHT.txt
HOW_TO_CONTRIBUTE.md
LICENSE.txt
README.md
package-lock.json
package.json
webpack.config.babel.js

README.md

RoundwareJS

Introduction

Roundware is a location-based contributory audio platform. This framework provides a JavaScript SDK for interacting with the Roundware Server API. The goal is to enable the creation of browser-based contributory audio and audio augmented reality applications. The library is written in ES6 but is built to run in all modern browsers that support HTML5 audio.

This is currently alpha software; the code is in flux!

Code Samples

<html>
  <body>
    <script type="text/javascript" src="https://unpkg.com/roundware-web-framework@0.0.1-alpha.4/dist/roundware.umd.min.js"></script>
    <script>
      var roundwareServerUrl = "http://localhost:8888/api/2";
      var roundwareProjectId = 1;

      var roundware = new Roundware({ serverUrl: roundwareServerUrl, projectId: roundwareProjectId });

      function handleListening(streamURL) {
        var streamPlayer = $("#streamplayer");
        var audioSource  = $("#audiosource");
        var pauseButton  = $("#pause");

        console.info("Starting to listen to " + streamURL);
        audioSource.prop("src",streamURL);

        streamPlayer.trigger("load");
        streamPlayer.trigger("play");

        pauseButton.click(function() {
          console.info("pausing");
          streamPlayer.trigger("pause");
        }).show();
      };

      $(function startApp() {
        roundware.start().then(handleListening);
      });
    </script>

    <audio id="streamplayer" style="border: solid 1px black;">
      <source id="audiosource" type="audio/mp3"></source>
    </audio>

    <button id="pause""display: none;">Pause</button>
  </body>
</html>

Installation

Node

npm install roundware-web-framework

Browser

Contributor Workflow

npm run devstart && open http://localhost:8080/ # open example/ app
npm run test                                    # execute Jasmine test suite
npm run deploy                                  # publish new version of package

See HOW_TO_CONTRIBUTE.md for further details.

Resources

References

Development

See HOW_TO_CONTRIBUTE.

Pieces of Flair

Build Status

Copyright and License

By Mike Subelsky and other authors. See COPYRIGHT.txt and LICENSE.txt for more details.