Permalink
Fetching contributors…
Cannot retrieve contributors at this time
executable file 122 lines (82 sloc) 3.7 KB

How to use?

Please make sure you've installed RTCMultiConnection.

All files from /dist directory are available on CDN: https://cdn.webrtc-experiment.com:443/

<!-- or -->
<script src="/dist/RTCMultiConnection.min.js"></script>

<!-- Heroku Link -->
<script src="https://rtcmulticonnection.herokuapp.com/dist/RTCMultiConnection.min.js"></script>

<!-- or specific version -->
<script src="https://github.com/muaz-khan/RTCMultiConnection/releases/download/3.4.3/RTCMultiConnection.js"></script>

<!-- or CDN -->
<script src="https://rawgit.com/muaz-khan/RTCMultiConnection/master/dist/RTCMultiConnection.min.js"></script>

If you're sharing files, you also need to link:

<script src="https://cdn.webrtc-experiment.com:443/FileBufferReader.js"></script>

You can link multiple files from dev directory. Order doesn't matters.

Use socket.io:

<script src="https://rtcmulticonnection.herokuapp.com/socket.io/socket.io.js"></script>

Set different socket URL

By default, RTCMultiConnection uses default port of your domain.

You can use custom ports either via config.json file:

{
  "socketURL": "http:s//yourdomain.com:9001/",
  "socketMessageEvent": "RTCMultiConnection-Message"
}

Or simply override in your HTML code:

connection.socketURL = 'https://yourdomain.com:9001/';

// if your server is already having "message" event
// then you can use something else, unique.
connection.socketMessageEvent = 'unique-message';

For testing purpose, you can use this as well:

{
  "socketURL": "https://rtcmulticonnection.herokuapp.com:443/",
  "socketMessageEvent": "RTCMultiConnection-Message"
}

Or:

connection.socketURL = 'https://rtcmulticonnection.herokuapp.com:443/';

Here is a demo explaining how to use above socketURL:

Integrate in your own applications?

// node.js code
require('./Signaling-Server.js')(httpServerHandlerOrPort);

If you're using express.js:

var fs = require('fs');

var options = {
    key: fs.readFileSync('fake-keys/privatekey.pem'),
    cert: fs.readFileSync('fake-keys/certificate.pem')
};

var express = require("express"),
    http = require("https"), // Use HTTPs here -------------
    app = express(),
    server = http.createServer(options, app);

server.listen(3000);

require('./Signaling-Server.js')(server);

Other Documents

  1. Installation Guide
  2. How to Use?
  3. API Reference
  4. Upgrade from v2 to v3
  5. How to write iOS/Android applications?
  6. Tips & Tricks

Twitter

License

RTCMultiConnection is released under MIT licence . Copyright (c) Muaz Khan.