Roundware-web-framework NPM | npm.io

0.12.8-alpha1 • Published 1 year ago

Install

Weekly downloads

42

License

AGPL-3.0-only

Repository

Last release

1 year ago

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.

Code Samples

<html>
  <body>
    <script type="text/javascript" src="https://unpkg.com/roundware-web-framework@0.9.0-alpha/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

See Roundware Web Demo for an example of using Roundware inside of an application

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

Code of Conduct
Documentation
Demo Site (and also check out examples)
Roundware Terminology
Source Code
npm package
CI Build
TODO figure out how to display code coverage report

References

How to Write an Open Source JavaScript Library: a lot of the initial project setup was adapted from this tutorial.

Development

See HOW_TO_CONTRIBUTE.

Pieces of Flair

Copyright and License

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

audio roundware

@turf/bbox @turf/boolean-point-in-polygon @turf/buffer @turf/distance @turf/line-to-polygon @turf/point-to-line-distance @types/lodash localforage lodash loglevel standardized-audio-context

@infinitebrahmanuniverse/nolb-rou @everything-registry/sub-chunk-2684

1 year ago

1 year ago

1 year ago

1 year ago

0.12.8-alpha.10

1 year ago

0.12.8-alpha.13

1 year ago

0.12.8-alpha.14

1 year ago

0.12.8-alpha.11

1 year ago

0.12.8-alpha.12

1 year ago

0.12.8-alpha.31

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

0.11.0-alpha.29

3 years ago

0.11.0-alpha.28

3 years ago

0.11.0-alpha.30

3 years ago

0.11.0-alpha.27

3 years ago

0.11.0-alpha.26

3 years ago

0.11.0-alpha.25

3 years ago

0.11.0-alpha.19

3 years ago

0.11.0-alpha.18

3 years ago

0.11.0-alpha.17

3 years ago

0.11.0-alpha.24

3 years ago

0.11.0-alpha.23

3 years ago

0.11.0-alpha.22

3 years ago

0.11.0-alpha.21

3 years ago

0.11.0-alpha.20

3 years ago

0.11.0-alpha.16

3 years ago

0.11.0-alpha.15

3 years ago

0.11.0-alpha.14

3 years ago

0.11.0-alpha.13

3 years ago

0.11.0-alpha.12

3 years ago

0.11.0-alpha.11

3 years ago

0.11.0-alpha.10

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago