callstats-kurento
v1.0.2
Published
Kurento Client interface for callstats.io
Downloads
8
Readme
callstats-kurento
Kurento Utils interface to callstats.io.
Install
- Adding a
<script>tag in the HTML.
In case no module loaded is used, a global window.callstatskurento is exposed.
NOTE: This library does not include the callstats.io library (it must be added separately).
Documentation
- Read the full documentation in the docs folder.
Usage example
In the HTML:
<!DOCTYPE html>
<html>
<head>
<!-- Load callstats.io library (it provides window.callstats -->
<script src="https://api.callstats.io/static/callstats.min.js"></script>
<!-- Load Kurento Utils library -->
<script src="bower_components/kurento-utils/js/kurento-utils.js"></script>
<!-- Load callstats-kurento library (it provides window.callstatskurento) -->
<script src="js/callstats-kurento.js"></script>
<!-- Load our app code -->
<script src="js/app.js"></script>
</head>
<body>
<!-- your stuff -->
</body>
</html>In app.js:
// Create a callstats-kurento App instance.
var ckApp;
var ckConference;
window.onload = function() {
ckApp = callstatskurento(
AppID,
AppSecret,
localUserID
);
// Create a callstats kurento conference interface, by supplying the CONFERENCE_ID
ckConference = cskApp.createConference(CONFERENCE_ID);
}webRtcPeer = kurentoUtils.WebRtcPeer.WebRtcPeerSendonly(options, function(error) {
if(error) return onError(error);
// Create a callstats-kurento peer, by handling the the webrTc peer returned by kurentoUtils
// and supplying a PEER_ID (a session ID).
var ckPeer = ckConference.handle(webRtcPeer, PEER_ID);
this.generateOffer(onOfferPresenter);
});Development
When using Bower or a <script> tag, the provided library is built with browserify, which means that it can be used with any kind of JavaScript module loader system (AMD, CommonJS, etc) or,
NPM/Bower libraries have been published to the NPM/Bower registries.
- Using NPM:
$ npm install callstats-kurento - Using Bower:
$ bower install callstats-kurento
Install NPM development dependencies:
$ npm installInstall gulp-cli globally (which provides the gulp command):
$ npm install -g gulpjsgulp prodgenerates a production/minifieddist/callstats-kurento.min.jsbundle.gulp devgenerates a development non-minified and sourcemaps enableddist/callstats-kurento.jsbundle.