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!Build & Install Locally
//
git clone git@github.com:roundware/roundware-web-framework.git
npm run build && npm pack
// isstall tarbal in your app
cd roundware-web-template
npm i ../roundware-web-framework/roundware-web-framework-0.12.4.tgz
npm startDevelopment with Framework & Web Template
npm watch
// inside web project
npm link ../roundware-web-frameworkCode 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>TypeScript
You can use TypeScript interfaces by prefixing the class name with I
Example:
import { IRoundware } from "roundware-web-framework/types";
const roundware: IRoundware = new Roundware(options);Installation
Node
npm install roundware-web-frameworkBrowser
- 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 packageSee 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.