Skip to content
JavaScript client written for NextRTC signaling server
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
distribution commited distribution Sep 8, 2018
source
test
.babelrc
.editorconfig New version of NextRTC client appropriate for RC5+ Jul 5, 2018
.gitignore New version of NextRTC client appropriate for RC5+ Jul 5, 2018
.npmignore latest version of adapter has been used Apr 6, 2018
LICENSE Initial commit Nov 2, 2014
README.md
package-lock.json
package.json

README.md

NextRTC JavaScript client

NextRTC js client constructor requires:

  • wsURL which should points to your endpoint {ws/wss}://{host}:{port}/{applicationName}/{endpointGivenInAnnotation} endpointGivenInAnnotation e.g. – @ServerEndpoint(value = “/signaling” …)
  • mediaConfig are passed straight to adapter, so more information about parametres you can find in webrtc/adapter documentation.
  • peerConfig are also described in webrtc/adapter project.

Example is shown below and it’s also available in nextrtc-sample-webapp

new NextRTC({
    wsURL : 'wss://examples.nextrtc.org/videochat/signaling',
    mediaConfig : {
        video : true,
        audio : true,
    },
    peerConfig : {
        'iceServers' : [ {
            url : "stun:stun.l.google.com:19302"
        }]
    }
}/*, optional DEBUG mode /true or false/*/);

How to use nextrtc-js-client on static page?

When page will be fully loaded you should create nextrtc object. If you don’t know when your page is fully loaded you can use override method NextRTC.onReady (this way of use is presented in example).

When you create NextRTC object you have to provide function which will be called when event happens. To register function you have to call method on() as presented in snipped:

var nextRTC = new NextRTC({
    ...
});

nextRTC.on('{eventName}', function(event:Event){
    
});

There are two signals which are providing other second parameter type. Those signals are: localStream and remoteStream, when you are handling local audio/video stream and incoming audio/video stream you can simply attach stream to valid element (without additional action like resolving stream by description provided in event).

nextRTC.on('{localStream|remoteStream}', function({stream: Stream, member: memberId}){

});

How to send / handle custom signals?

On the js side you have to write two methods. One for sending new signal

NextRTC.prototype.upperCase = function upperCase(content, custom) {
    this.channel.send({signal: 'upperCase', content: 'content', custom: custom});
}; 

second one which will react on the response:

nextRTC.on('upperCase', content => {
// here you should handle the response
});

Then you will be able to use structure like this to post your custom signal:

nexrtc.upperCase('lowerCase');

Model

Event structure and available events are presented here

Event is serialized java version of message.

You can’t perform that action at this time.