Simplified web-based real-time communications built around WebRTC, SIP, MSRP, and XMPP.
If you're only interested in using the library, you can download the single-file concatenated or minified versions from https://www.crocodilertc.net/sdk.
In your web page:
<script src="jquery.js"></script>
<script src="dist/crocodile-rtc.min.js"></script>
<script>
$(document).ready(function() {
var croc = $.croc({
apiKey: "abcdefghijklmnopqrst",
onConnected: function() {
// Ready to start communicating!
}
});
});
</script>Please also consider joining the mailing lists so you can ask for assistance and keep up-to-speed with the latest developments in the library:
- crocodile-rtc-announce: Announcements of new releases, features, etc.
- crocodile-rtc-discuss: General discussion - ask questions and raise issues here.
The only dependency required by the distributed library is jQuery. The library has primarily been tested with jQuery 1.9.1.
The following libraries are "wrapped up" within the distributed library, and are thus required at build time:
- JsSIP (http://jssip.net) - currently using a custom branch available here: https://github.com/crocodilertc/JsSIP
- JSJaC (https://github.com/sstrigler/JSJaC) - currently using the unreleased commit with SHA 6c2d4f78d49f18aa8bd0f7c4c278b873d22c7451
- crocodile-msrp (https://code.google.com/p/crocodile-msrp/) - currently using v1.0.0
The unit testing also depends on QUnit (http://qunitjs.com/); v1.11.0 is included for convenience.
The documentation for the current release is available at http://www.crocodilertc.net/documentation
Alternatively, you can build the latest documentation directly from the JSDoc comments in the code; see CONTRIBUTING.md for instructions on building the code.
If the documentation doesn't help, please visit the crocodile-rtc-discuss mailing list or the forums for further assistance.
(Coming soon)
See CONTRIBUTING.md
No releases yet!