https://github.com/purecloudlabs/zombese
https://github.com/purecloudlabs/zombese
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/purecloudlabs/zombese
- Owner: purecloudlabs
- License: mit
- Created: 2016-07-20T00:52:06.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T06:33:58.000Z (over 1 year ago)
- Last Synced: 2025-03-31T09:37:54.269Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 84 KB
- Stars: 0
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
zombese [](https://travis-ci.org/bandwidthcom/zombese)
=======
Part of [Bandwidth Open Source](http://bandwidth.com/?utm_medium=social&utm_source=github&utm_campaign=dtolb&utm_content=_)
This branch only exists has a temporary copy of upstream's master with all
pending PRs merged. As upstream PRs are merged, this branch will be rebased on
upstream master.
A WebRTC extension for [Zombie.js](https://github.com/assaf/zombie).
Zombese is only intended to cover the happy path for setting up a WebRTC connection between two clients running in ```Zombie.js```. Because of this, only orchestration-related parts of the WebRTC API are implemented. Things like the ```MediaStream``` API are not implemented.
## Zombese Dialects
Zombese can be spoken in different dialects. The currently supported dialects of zombese are:
- Firefox (Firefox WebRTC API)
The dialects are exposed in the ```zombese.dialects``` object:
```
{
default : FirefoxZombeseDialect,
firefox : FirefoxZombeseDialect
}
```
## Extending the Browser API
`zombie` provides an extension API that allows all new `Browser`
objects to be augmented with additional functionality. Using this approach,
`zombese` will create a mocked WebRTC API in all new windows / tabs.
Without a dialect:
```javascript
var Browser = require("zombie");
var zombese = require("zombese");
var browser;
Browser.extend(zombese()); // uses the default dialect
browser = new Browser();
```
With a dialect:
```javascript
var Browser = require("zombie");
var zombese = require("zombese");
var browser;
Browser.extend(zombese(zombese.dialects.firefox)); // uses the firefox dialect
browser = new Browser();
```
The `zombese` function has the following parameters:
- dialect: The dialect to use when teaching a Browser `zombese`
- optional
- default: ```zombese.dialects.default```
## License
[MIT License](/LICENSE)