Phone system abstraction layer
Core Tech: RXJS, Verto, WebRTC & Freeswitch
Installation
npm install @blueface_npm/barcelona
Must add this assets:
file: ring.mp3 Location: ./assets/audio/ring.mp3 Goal: To have ring sound on incoming calls
file: beep.mp3 Location: ./assets/audio/ring.mp3 Goal: To have ring sound on incoming calls when you are connected to other calls
Usage
- [[RelayClient]] allows to manage a list of calls with different functionalities
- [[WebRTCSession]] controls the WebRTC connection, discovery, and the media streams
- [[VertoSession]] allows to send commands and parse events through web sockets
Testing changes locally
In Barcelona's folder:
$ npm link
And for every change:
$ npm run build
Or alternatively:
$ npm run watch
Which will rebuild on every change (useful during development).
In your app's folder (webphone, palantir):
$ npm link @blueface_npm/barcelona
Angular should automatically pick up any change and rebuild from there.
Documentation
First, run $ npm run docs
You can then open the documentation in docs/index.html
Publishing a new version
Barcelona follows the Semver version convention:
- Major version for are breaking changes
- Minor version for non-breaking functional changes
- Patches for non-breaking bugfixes only
- Document your changes in CHANGELOG.md and commit them
$ npm version major|minor|patch
$ npm publish
$ git push origin master --tags